From 8bcc9c09d79111da9d79e2c30e55d6cb3f936f7a Mon Sep 17 00:00:00 2001 From: Charles Lavery Date: Mon, 2 Mar 2026 20:36:35 -0500 Subject: [PATCH 1/2] Reorganize docs navigation into Guides, Reference, and SDK sections Split the single 50+ item shared sidebar into purpose-driven sidebars: - Guides sidebar: Getting Started, How-To, MCP Server, Extending - Reference sidebar: CLI Commands (alphabetized) + MCP Tools - SDK sidebar: renamed from "API Reference" Product-qualify ambiguous labels (CLI Installation vs MCP Installation) and update nav bar (Guides | MCP | Reference | SDK). --- docs/.vitepress/config.mts | 68 ++++++++++++++++++++------------------ docs/api-readme.md | 4 +-- docs/guide/index.md | 4 +-- docs/index.md | 9 ++--- 4 files changed, 43 insertions(+), 42 deletions(-) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 994fd9df..4b90b4aa 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -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'}, @@ -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'}, ], @@ -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'}, @@ -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(), @@ -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, diff --git a/docs/api-readme.md b/docs/api-readme.md index acec4f26..63af95d2 100644 --- a/docs/api-readme.md +++ b/docs/api-readme.md @@ -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. diff --git a/docs/guide/index.md b/docs/guide/index.md index 9f1fd365..5b7fc7ed 100644 --- a/docs/guide/index.md +++ b/docs/guide/index.md @@ -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 diff --git a/docs/index.md b/docs/index.md index 913fc586..1898a8ea 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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" @@ -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. From 9481d172901738323c774cf29be3255b16c154a4 Mon Sep 17 00:00:00 2001 From: Charles Lavery Date: Mon, 2 Mar 2026 20:40:06 -0500 Subject: [PATCH 2/2] Add changeset for docs navigation reorganization --- .changeset/reorganize-docs-navigation.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/reorganize-docs-navigation.md diff --git a/.changeset/reorganize-docs-navigation.md b/.changeset/reorganize-docs-navigation.md new file mode 100644 index 00000000..36c5784f --- /dev/null +++ b/.changeset/reorganize-docs-navigation.md @@ -0,0 +1,5 @@ +--- +'@salesforce/b2c-dx-docs': patch +--- + +Reorganize documentation navigation into Guides, Reference, and SDK sections for clearer information architecture