Skip to content

Commit 31a0c2d

Browse files
author
Mohammod Al Amin Ashik
committed
adds documentation
1 parent d660bd6 commit 31a0c2d

File tree

492 files changed

+17247
-17
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

492 files changed

+17247
-17
lines changed

docs/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Sitecore Marketplace SDK Documentation
2+
3+
Welcome to the Sitecore Marketplace SDK documentation. This SDK provides tools for building applications that integrate with Sitecore's marketplace platform.
4+
5+
## 📚 SDK Packages
6+
7+
### Core SDK
8+
9+
The foundation package providing core functionality and types.
10+
11+
- [Core SDK Documentation](./core-sdk/README.md)
12+
13+
### Client SDK
14+
15+
React-based SDK for building client-side marketplace applications.
16+
17+
- [Client SDK Documentation](./client/README.md)
18+
19+
### XMC Package
20+
21+
Extended Marketplace Client package with API access and experimental features.
22+
23+
- [XMC Module Documentation](./modules/xmc/README.md)
24+
- [EXPERIMENTAL_XMC Documentation](./experimental-xmc.md) - Server-to-server API access
25+
26+
## 🎯 Use Cases
27+
28+
- **Client-Side Apps**: Use Client SDK for React applications
29+
- **Server-Side Apps**: Use EXPERIMENTAL_XMC for Node.js, serverless functions
30+
- **Microservices**: Direct API access for service-to-service communication
31+
- **Build Scripts**: Content deployment and automation scripts

docs/core-sdk/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
## Enumerations
88

9+
- [AllowedExtensionPoints](enumerations/AllowedExtensionPoints.md)
910
- [~~AllowedTouchpoints~~](enumerations/AllowedTouchpoints.md)
1011
- [ErrorCode](enumerations/ErrorCode.md)
1112

@@ -47,5 +48,4 @@
4748

4849
## Type Aliases
4950

50-
- [AllowedExtensionPoints](type-aliases/AllowedExtensionPoints.md)
5151
- [Message](type-aliases/Message.md)
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
[**@sitecore-marketplace-sdk/core**](../README.md)
2+
3+
***
4+
5+
[@sitecore-marketplace-sdk/core](../README.md) / AllowedExtensionPoints
6+
7+
# Enumeration: AllowedExtensionPoints
8+
9+
Defined in: [packages/core/src/constants.ts:16](https://github.com/Sitecore/marketplace-sdk/blob/main/packages/core/src/constants.ts#L16)
10+
11+
Allowed extension points for Sitecore Marketplace applications.
12+
This enum defines the valid extension points where applications can be embedded.
13+
14+
## Enumeration Members
15+
16+
### standalone
17+
18+
> **standalone**: `"standalone"`
19+
20+
Defined in: [packages/core/src/constants.ts:17](https://github.com/Sitecore/marketplace-sdk/blob/main/packages/core/src/constants.ts#L17)
21+
22+
***
23+
24+
### xmcDashboardBlocks
25+
26+
> **xmcDashboardBlocks**: `"xmc:dashboardblocks"`
27+
28+
Defined in: [packages/core/src/constants.ts:21](https://github.com/Sitecore/marketplace-sdk/blob/main/packages/core/src/constants.ts#L21)
29+
30+
***
31+
32+
### xmcFullscreen
33+
34+
> **xmcFullscreen**: `"xmc:fullscreen"`
35+
36+
Defined in: [packages/core/src/constants.ts:18](https://github.com/Sitecore/marketplace-sdk/blob/main/packages/core/src/constants.ts#L18)
37+
38+
***
39+
40+
### xmcPagesContextPanel
41+
42+
> **xmcPagesContextPanel**: `"xmc:pages:contextpanel"`
43+
44+
Defined in: [packages/core/src/constants.ts:19](https://github.com/Sitecore/marketplace-sdk/blob/main/packages/core/src/constants.ts#L19)
45+
46+
***
47+
48+
### xmcPagesCustomField
49+
50+
> **xmcPagesCustomField**: `"xmc:pages:customfield"`
51+
52+
Defined in: [packages/core/src/constants.ts:20](https://github.com/Sitecore/marketplace-sdk/blob/main/packages/core/src/constants.ts#L20)

docs/core-sdk/interfaces/ApplicationRuntimeContext.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@ Defined in: [packages/core/src/shared-types.ts:202](https://github.com/Sitecore/
7676

7777
***
7878

79-
### ~~resources~~
79+
### ~~resources?~~
8080

81-
> **resources**: [`ApplicationResourceContext`](ApplicationResourceContext.md)[]
81+
> `optional` **resources**: [`ApplicationResourceContext`](ApplicationResourceContext.md)[]
8282
8383
Defined in: [packages/core/src/shared-types.ts:199](https://github.com/Sitecore/marketplace-sdk/blob/main/packages/core/src/shared-types.ts#L199)
8484

@@ -88,9 +88,9 @@ Use resourceAccess instead
8888

8989
***
9090

91-
### ~~touchpoints~~
91+
### ~~touchpoints?~~
9292

93-
> **touchpoints**: [`ApplicationTouchpointContext`](ApplicationTouchpointContext.md)[]
93+
> `optional` **touchpoints**: [`ApplicationTouchpointContext`](ApplicationTouchpointContext.md)[]
9494
9595
Defined in: [packages/core/src/shared-types.ts:201](https://github.com/Sitecore/marketplace-sdk/blob/main/packages/core/src/shared-types.ts#L201)
9696

docs/core-sdk/type-aliases/AllowedExtensionPoints.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)