Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/reorganize-docs-navigation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@salesforce/b2c-dx-docs': patch
---

Reorganize documentation navigation into Guides, Reference, and SDK sections for clearer information architecture
68 changes: 36 additions & 32 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,18 @@ function getVersionItems() {
];
}

const guideSidebar = [
const guidesSidebar = [
{
text: 'Getting Started',
items: [
{text: 'Introduction', link: '/guide/'},
{text: 'Installation', link: '/guide/installation'},
{text: 'Configuration', link: '/guide/configuration'},
{text: 'CLI Installation', link: '/guide/installation'},
{text: 'CLI Configuration', link: '/guide/configuration'},
{text: 'Agent Skills & Plugins', link: '/guide/agent-skills'},
],
},
{
text: 'Guides',
text: 'How-To',
items: [
{text: 'Authentication Setup', link: '/guide/authentication'},
{text: 'CI/CD with GitHub Actions', link: '/guide/ci-cd'},
Expand All @@ -55,8 +55,8 @@ const guideSidebar = [
text: 'MCP Server',
items: [
{text: 'Overview', link: '/mcp/'},
{text: 'Installation', link: '/mcp/installation'},
{text: 'Configuration', link: '/mcp/configuration'},
{text: 'MCP Installation', link: '/mcp/installation'},
{text: 'MCP Configuration', link: '/mcp/configuration'},
{text: 'Toolsets & Tools', link: '/mcp/toolsets'},
{text: 'Figma Tools Setup', link: '/mcp/figma-tools-setup'},
],
Expand All @@ -68,33 +68,36 @@ const guideSidebar = [
{text: '3rd Party Plugins', link: '/guide/third-party-plugins'},
],
},
];

const referenceSidebar = [
{
text: 'CLI Reference',
text: 'CLI Commands',
items: [
{text: 'Overview', link: '/cli/'},
{text: 'Code Commands', link: '/cli/code'},
{text: 'Content Commands', link: '/cli/content'},
{text: 'CIP Commands', link: '/cli/cip'},
{text: 'Job Commands', link: '/cli/jobs'},
{text: 'Logs Commands', link: '/cli/logs'},
{text: 'Sites Commands', link: '/cli/sites'},
{text: 'WebDAV Commands', link: '/cli/webdav'},
{text: 'Sandbox Commands', link: '/cli/sandbox'},
{text: 'MRT Commands', link: '/cli/mrt'},
{text: 'eCDN Commands', link: '/cli/ecdn'},
{text: 'SLAS Commands', link: '/cli/slas'},
{text: 'Account Manager', link: '/cli/account-manager'},
{text: 'Auth', link: '/cli/auth'},
{text: 'CIP', link: '/cli/cip'},
{text: 'Code', link: '/cli/code'},
{text: 'Content', link: '/cli/content'},
{text: 'Custom APIs', link: '/cli/custom-apis'},
{text: 'Docs', link: '/cli/docs'},
{text: 'eCDN', link: '/cli/ecdn'},
{text: 'Jobs', link: '/cli/jobs'},
{text: 'Logs', link: '/cli/logs'},
{text: 'MRT', link: '/cli/mrt'},
{text: 'Sandbox', link: '/cli/sandbox'},
{text: 'Scaffold', link: '/cli/scaffold'},
{text: 'SCAPI Schemas', link: '/cli/scapi-schemas'},
{text: 'Setup Commands', link: '/cli/setup'},
{text: 'Scaffold Commands', link: '/cli/scaffold'},
{text: 'Docs Commands', link: '/cli/docs'},
{text: 'Auth Commands', link: '/cli/auth'},
{text: 'Account Manager Commands', link: '/cli/account-manager'},
{text: 'Setup', link: '/cli/setup'},
{text: 'Sites', link: '/cli/sites'},
{text: 'SLAS', link: '/cli/slas'},
{text: 'WebDAV', link: '/cli/webdav'},
{text: 'Logging', link: '/cli/logging'},
],
},
{
text: 'Tools Reference',
text: 'MCP Tools',
items: [
{text: 'cartridge_deploy', link: '/mcp/tools/cartridge-deploy'},
{text: 'mrt_bundle_push', link: '/mcp/tools/mrt-bundle-push'},
Expand Down Expand Up @@ -157,10 +160,10 @@ export default defineConfig({
level: [2, 3],
},
nav: [
{text: 'Guide', link: '/guide/'},
{text: 'CLI Reference', link: '/cli/'},
{text: 'API Reference', link: '/api/'},
{text: 'MCP Server', link: '/mcp/'},
{text: 'Guides', link: '/guide/'},
{text: 'MCP', link: '/mcp/'},
{text: 'Reference', link: '/cli/'},
{text: 'SDK', link: '/api/'},
{
text: isDevBuild ? 'Dev' : 'Latest',
items: getVersionItems(),
Expand All @@ -173,12 +176,13 @@ export default defineConfig({
},

sidebar: {
'/guide/': guideSidebar,
'/cli/': guideSidebar,
'/mcp/': guideSidebar,
'/mcp/tools/': referenceSidebar,
'/mcp/': guidesSidebar,
'/cli/': referenceSidebar,
'/guide/': guidesSidebar,
'/api/': [
{
text: 'API Reference',
text: 'SDK Reference',
items: [{text: 'Overview', link: '/api/'}],
},
...typedocSidebar,
Expand Down
4 changes: 2 additions & 2 deletions docs/api-readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
description: API reference for the B2C Tooling SDK with typed WebDAV and OCAPI clients for programmatic B2C Commerce operations.
description: SDK reference for the B2C Tooling SDK with typed WebDAV and OCAPI clients for programmatic B2C Commerce operations.
---

# API Reference
# SDK Reference

The `@salesforce/b2c-tooling-sdk` package provides TypeScript APIs for B2C Commerce development, including instance clients (WebDAV, OCAPI), platform service clients (SCAPI, SLAS, MRT, ODS), high-level operations, and developer utilities.

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,5 @@ See the [MCP Server Installation Guide](/mcp/installation) for detailed setup in
- [IDE Integration](./ide-integration) - Connect Prophet VS Code to B2C CLI configuration
- [MCP Server](/mcp/) - AI-assisted development with Model Context Protocol
- [CLI Reference](/cli/) - Browse available commands
- [Tools Reference](/mcp/toolsets) - Explore MCP tools for cartridges, MRT, SCAPI, and so on
- [API Reference](/api/) - Explore the SDK API
- [MCP Tools](/mcp/toolsets) - Explore MCP tools for cartridges, MRT, SCAPI, and so on
- [SDK Reference](/api/) - Explore the SDK
9 changes: 3 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,12 @@ hero:
- theme: brand
text: Get Started
link: /guide/
- theme: alt
text: CLI Reference
link: /cli/
- theme: alt
text: MCP Server
link: /mcp/
- theme: alt
text: API Reference
link: /api/
text: Reference
link: /cli/

features:
- icon: "\U0001F680"
Expand Down Expand Up @@ -53,7 +50,7 @@ features:
title: SDK Library
details: Build custom integrations with @salesforce/b2c-tooling-sdk - the same SDK powering the CLI.
link: /api/
linkText: API Reference
linkText: SDK Reference
- icon: "\U0001F510"
title: Account Management
details: Manage users, roles, organizations, and API clients in Account Manager via CLI and SDK.
Expand Down
Loading