Skip to content

Commit b893aa8

Browse files
authored
Reorganize docs navigation into Guides, Reference, and SDK (#229)
* 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). * Add changeset for docs navigation reorganization
1 parent 824d83c commit b893aa8

File tree

5 files changed

+48
-42
lines changed

5 files changed

+48
-42
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@salesforce/b2c-dx-docs': patch
3+
---
4+
5+
Reorganize documentation navigation into Guides, Reference, and SDK sections for clearer information architecture

docs/.vitepress/config.mts

Lines changed: 36 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,18 @@ function getVersionItems() {
2828
];
2929
}
3030

31-
const guideSidebar = [
31+
const guidesSidebar = [
3232
{
3333
text: 'Getting Started',
3434
items: [
3535
{text: 'Introduction', link: '/guide/'},
36-
{text: 'Installation', link: '/guide/installation'},
37-
{text: 'Configuration', link: '/guide/configuration'},
36+
{text: 'CLI Installation', link: '/guide/installation'},
37+
{text: 'CLI Configuration', link: '/guide/configuration'},
3838
{text: 'Agent Skills & Plugins', link: '/guide/agent-skills'},
3939
],
4040
},
4141
{
42-
text: 'Guides',
42+
text: 'How-To',
4343
items: [
4444
{text: 'Authentication Setup', link: '/guide/authentication'},
4545
{text: 'CI/CD with GitHub Actions', link: '/guide/ci-cd'},
@@ -55,8 +55,8 @@ const guideSidebar = [
5555
text: 'MCP Server',
5656
items: [
5757
{text: 'Overview', link: '/mcp/'},
58-
{text: 'Installation', link: '/mcp/installation'},
59-
{text: 'Configuration', link: '/mcp/configuration'},
58+
{text: 'MCP Installation', link: '/mcp/installation'},
59+
{text: 'MCP Configuration', link: '/mcp/configuration'},
6060
{text: 'Toolsets & Tools', link: '/mcp/toolsets'},
6161
{text: 'Figma Tools Setup', link: '/mcp/figma-tools-setup'},
6262
],
@@ -68,33 +68,36 @@ const guideSidebar = [
6868
{text: '3rd Party Plugins', link: '/guide/third-party-plugins'},
6969
],
7070
},
71+
];
72+
73+
const referenceSidebar = [
7174
{
72-
text: 'CLI Reference',
75+
text: 'CLI Commands',
7376
items: [
7477
{text: 'Overview', link: '/cli/'},
75-
{text: 'Code Commands', link: '/cli/code'},
76-
{text: 'Content Commands', link: '/cli/content'},
77-
{text: 'CIP Commands', link: '/cli/cip'},
78-
{text: 'Job Commands', link: '/cli/jobs'},
79-
{text: 'Logs Commands', link: '/cli/logs'},
80-
{text: 'Sites Commands', link: '/cli/sites'},
81-
{text: 'WebDAV Commands', link: '/cli/webdav'},
82-
{text: 'Sandbox Commands', link: '/cli/sandbox'},
83-
{text: 'MRT Commands', link: '/cli/mrt'},
84-
{text: 'eCDN Commands', link: '/cli/ecdn'},
85-
{text: 'SLAS Commands', link: '/cli/slas'},
78+
{text: 'Account Manager', link: '/cli/account-manager'},
79+
{text: 'Auth', link: '/cli/auth'},
80+
{text: 'CIP', link: '/cli/cip'},
81+
{text: 'Code', link: '/cli/code'},
82+
{text: 'Content', link: '/cli/content'},
8683
{text: 'Custom APIs', link: '/cli/custom-apis'},
84+
{text: 'Docs', link: '/cli/docs'},
85+
{text: 'eCDN', link: '/cli/ecdn'},
86+
{text: 'Jobs', link: '/cli/jobs'},
87+
{text: 'Logs', link: '/cli/logs'},
88+
{text: 'MRT', link: '/cli/mrt'},
89+
{text: 'Sandbox', link: '/cli/sandbox'},
90+
{text: 'Scaffold', link: '/cli/scaffold'},
8791
{text: 'SCAPI Schemas', link: '/cli/scapi-schemas'},
88-
{text: 'Setup Commands', link: '/cli/setup'},
89-
{text: 'Scaffold Commands', link: '/cli/scaffold'},
90-
{text: 'Docs Commands', link: '/cli/docs'},
91-
{text: 'Auth Commands', link: '/cli/auth'},
92-
{text: 'Account Manager Commands', link: '/cli/account-manager'},
92+
{text: 'Setup', link: '/cli/setup'},
93+
{text: 'Sites', link: '/cli/sites'},
94+
{text: 'SLAS', link: '/cli/slas'},
95+
{text: 'WebDAV', link: '/cli/webdav'},
9396
{text: 'Logging', link: '/cli/logging'},
9497
],
9598
},
9699
{
97-
text: 'Tools Reference',
100+
text: 'MCP Tools',
98101
items: [
99102
{text: 'cartridge_deploy', link: '/mcp/tools/cartridge-deploy'},
100103
{text: 'mrt_bundle_push', link: '/mcp/tools/mrt-bundle-push'},
@@ -157,10 +160,10 @@ export default defineConfig({
157160
level: [2, 3],
158161
},
159162
nav: [
160-
{text: 'Guide', link: '/guide/'},
161-
{text: 'CLI Reference', link: '/cli/'},
162-
{text: 'API Reference', link: '/api/'},
163-
{text: 'MCP Server', link: '/mcp/'},
163+
{text: 'Guides', link: '/guide/'},
164+
{text: 'MCP', link: '/mcp/'},
165+
{text: 'Reference', link: '/cli/'},
166+
{text: 'SDK', link: '/api/'},
164167
{
165168
text: isDevBuild ? 'Dev' : 'Latest',
166169
items: getVersionItems(),
@@ -173,12 +176,13 @@ export default defineConfig({
173176
},
174177

175178
sidebar: {
176-
'/guide/': guideSidebar,
177-
'/cli/': guideSidebar,
178-
'/mcp/': guideSidebar,
179+
'/mcp/tools/': referenceSidebar,
180+
'/mcp/': guidesSidebar,
181+
'/cli/': referenceSidebar,
182+
'/guide/': guidesSidebar,
179183
'/api/': [
180184
{
181-
text: 'API Reference',
185+
text: 'SDK Reference',
182186
items: [{text: 'Overview', link: '/api/'}],
183187
},
184188
...typedocSidebar,

docs/api-readme.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
description: API reference for the B2C Tooling SDK with typed WebDAV and OCAPI clients for programmatic B2C Commerce operations.
2+
description: SDK reference for the B2C Tooling SDK with typed WebDAV and OCAPI clients for programmatic B2C Commerce operations.
33
---
44

5-
# API Reference
5+
# SDK Reference
66

77
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.
88

docs/guide/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,5 +69,5 @@ See the [MCP Server Installation Guide](/mcp/installation) for detailed setup in
6969
- [IDE Integration](./ide-integration) - Connect Prophet VS Code to B2C CLI configuration
7070
- [MCP Server](/mcp/) - AI-assisted development with Model Context Protocol
7171
- [CLI Reference](/cli/) - Browse available commands
72-
- [Tools Reference](/mcp/toolsets) - Explore MCP tools for cartridges, MRT, SCAPI, and so on
73-
- [API Reference](/api/) - Explore the SDK API
72+
- [MCP Tools](/mcp/toolsets) - Explore MCP tools for cartridges, MRT, SCAPI, and so on
73+
- [SDK Reference](/api/) - Explore the SDK

docs/index.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,12 @@ hero:
1313
- theme: brand
1414
text: Get Started
1515
link: /guide/
16-
- theme: alt
17-
text: CLI Reference
18-
link: /cli/
1916
- theme: alt
2017
text: MCP Server
2118
link: /mcp/
2219
- theme: alt
23-
text: API Reference
24-
link: /api/
20+
text: Reference
21+
link: /cli/
2522

2623
features:
2724
- icon: "\U0001F680"
@@ -53,7 +50,7 @@ features:
5350
title: SDK Library
5451
details: Build custom integrations with @salesforce/b2c-tooling-sdk - the same SDK powering the CLI.
5552
link: /api/
56-
linkText: API Reference
53+
linkText: SDK Reference
5754
- icon: "\U0001F510"
5855
title: Account Management
5956
details: Manage users, roles, organizations, and API clients in Account Manager via CLI and SDK.

0 commit comments

Comments
 (0)