Skip to content

Commit 5f36697

Browse files
committed
Friendlier docs voice; restructure highlights; add real screenshots
- Soften the intro and per-feature copy on index.md / installation.md; remove dw.json/SFCC_* jargon from outward-facing prose. - Reorder highlights and add screenshots for the three biggest ones (Sandbox Realm Explorer, Library Explorer, Script Debugger). Make highlight images clickable so the inline thumbnail can be expanded to the full-resolution capture. - Rename Cartridge Code Sync -> "Cartridge Management and Code Watch/ Upload"; add SCAPI API Explorer as a dedicated highlight. - Drop the Page Designer Assistant highlight; promote Scaffolding to a highlight in its place (covers cartridges, controllers, hooks, jobs). - Expand the Script Debugger blurb to call out controllers, jobs, custom scripts, SCAPI hooks, Custom APIs, breakpoints, and log points. - Delete features.md; fold Log Tailing, Active Instance Status Bar, and B2C CLI Plugin Support onto index.md and update sidebar / cross-links. - Drop Project Root Pinning from configuration.md (uncommon use case). - Mention the VS Code Extension on docs/guide/index.md with a quick- install block parallel to the CLI/MCP installs, using the existing release.data.ts loader.
1 parent c5e3411 commit 5f36697

12 files changed

Lines changed: 93 additions & 240 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,6 @@ const guidesSidebar = [
8282
{text: 'Overview', link: '/vscode-extension/'},
8383
{text: 'Installation', link: '/vscode-extension/installation'},
8484
{text: 'Configuration', link: '/vscode-extension/configuration'},
85-
{text: 'Features', link: '/vscode-extension/features'},
8685
],
8786
},
8887
{

docs/guide/index.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
---
2-
description: Introduction to the Agentic B2C Developer Toolkit — CLI, Agent Skills, MCP Server, and SDK for Salesforce Agentforce Commerce.
2+
description: Introduction to the Agentic B2C Developer Toolkit — CLI, Agent Skills, MCP Server, VS Code extension, and SDK for Salesforce Agentforce Commerce.
33
---
44

5+
<script setup>
6+
import {data as vsxRelease} from '../vscode-extension/release.data.ts';
7+
</script>
8+
59
# Introduction
610

711
The Agentic B2C Developer Toolkit exposes the B2C Commerce platform as commands, MCP tools, and coding skills — so you and your AI agents can build, deploy, and operate storefronts from the terminal or directly inside your IDE. No clicking through Business Manager to deploy, no context-switching to run a job, no manual copy-paste when your agent needs to touch a live sandbox.
812

913
- **B2C CLI** — a single command for every workflow: cartridge deploys, jobs, ODS/MRT, WebDAV, site archives, SLAS, eCDN, Account Manager, CI/CD.
1014
- **Agent Skills** — 30+ preconfigured skills that teach your coding agent (Claude Code, Cursor, Agentforce Vibes, Copilot, Codex) how B2C Commerce works — SCAPI Custom APIs, SLAS, SFRA controllers and forms, ISML, Page Designer, hooks, custom objects — and which CLI commands to run when.
1115
- **MCP Server** — a focused set of MCP tools that complement the CLI for agent-driven workflows.
16+
- **VS Code Extension** *(Developer Preview)* — sandbox management, cartridge code sync, content libraries, SCAPI explorer, and a server-side script debugger right inside VS Code.
1217
- **Tooling SDK** — everything the CLI does, available as a typed TypeScript SDK for custom integrations.
1318

1419
## Quick CLI Install
@@ -74,13 +79,37 @@ claude plugin install b2c-dx-mcp --scope project
7479

7580
See the [MCP Server Installation Guide](/mcp/installation) for full setup steps and troubleshooting.
7681

82+
## Quick VS Code Extension Install <Badge type="warning" text="Developer Preview" />
83+
84+
The B2C DX VS Code Extension brings sandbox management, code sync, content libraries, the SCAPI explorer, and a server-side debugger into VS Code. It isn't on the Marketplace yet — install the latest pre-built `.vsix` from GitHub.
85+
86+
<div v-if="!vsxRelease.unavailable">
87+
88+
Latest version: <strong>{{ vsxRelease.version }}</strong> · <a :href="vsxRelease.vsixDownloadUrl">Download {{ vsxRelease.vsixAssetName }}</a> · <a :href="vsxRelease.releasePageUrl">Release notes</a>
89+
90+
```bash
91+
code --install-extension {{ vsxRelease.vsixAssetName }}
92+
# or, in Cursor:
93+
cursor --install-extension {{ vsxRelease.vsixAssetName }}
94+
```
95+
96+
</div>
97+
<div v-else>
98+
99+
The extension hasn't shipped a release yet. Browse the <a :href="vsxRelease.fallbackUrl">GitHub releases page</a> for `b2c-vs-extension@*` tags.
100+
101+
</div>
102+
103+
See the [VS Code Extension](/vscode-extension/) section for the full overview, [installation](/vscode-extension/installation), and [configuration](/vscode-extension/configuration).
104+
77105
## Next Steps
78106

79107
- [Authentication Setup](./authentication) - Set up Account Manager, OCAPI, and WebDAV
80108
- [Analytics Reports (CIP/CCAC)](./analytics-reports-cip-ccac) - Run curated analytics reports and SQL queries
81109
- [Configuration](./configuration) - Configure instances and credentials
82110
- [IDE Integration](./ide-integration) - Connect Prophet VS Code to B2C CLI configuration
83111
- [MCP Server](/mcp/) - AI-assisted development with Model Context Protocol
112+
- [VS Code Extension](/vscode-extension/) - Sandbox management, code sync, and the script debugger inside VS Code
84113
- [CLI Reference](/cli/) - Browse available commands
85114
- [MCP Tools](/mcp/toolsets) - Explore MCP tools for cartridges, MRT, SCAPI, and so on
86115
- [SDK Reference](/api/) - Explore the SDK

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,5 +152,5 @@ Browse the [GitHub releases page]({{ vsxRelease.fallbackUrl }}) for `b2c-vs-exte
152152

153153
</div>
154154

155-
Detailed setup: [Installation](/vscode-extension/installation) · [Configuration](/vscode-extension/configuration) · [Features](/vscode-extension/features)
155+
Detailed setup: [Installation](/vscode-extension/installation) · [Configuration](/vscode-extension/configuration)
156156

docs/vscode-extension/configuration.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ This page covers:
1010

1111
- [Connecting to a B2C Instance](#connecting-to-a-b2c-instance) — credentials per feature.
1212
- [Switching the Active Instance](#switching-the-active-instance) — single-workspace, multi-instance.
13-
- [Project Root Pinning](#project-root-pinning) — multi-root workspaces.
1413
- [Settings Reference](#settings-reference) — the `b2c-dx.*` toggles and verbosity controls.
1514

1615
## Connecting to a B2C Instance
@@ -19,7 +18,7 @@ The extension needs different credentials depending on which feature you use. **
1918

2019
### Per-feature requirements
2120

22-
Each feature documents its own requirements in [Features](./features). The summary:
21+
A summary by feature:
2322

2423
| Feature | Required `dw.json` fields |
2524
| ------- | ------------------------- |
@@ -66,15 +65,6 @@ When `dw.json` defines multiple named instances (the recommended pattern for wor
6665

6766
The same pointer is shared with the CLI: switching here is equivalent to running `b2c setup instance set-active <name>`.
6867

69-
## Project Root Pinning
70-
71-
In a multi-root workspace, the extension auto-detects the project root by walking up from the active editor (or the first workspace folder) looking for `dw.json` / `package.json` markers. Two commands let you override the auto-detected root:
72-
73-
- **B2C DX: Use as B2C Commerce Root** — only available on a workspace-root folder when more than one folder is open in the workspace. Right-click that folder in the Explorer and select the command to pin it. While a pin is active, the status bar shows a `$(pinned)` indicator.
74-
- **B2C DX: Reset B2C Commerce Root to Auto-Detect** — clears the pin and returns to auto-detection. Run from the Command Palette (this command has no Explorer context-menu entry).
75-
76-
The pin is workspace-scoped (stored in workspace state).
77-
7868
## Settings Reference
7969

8070
These VS Code settings live under the `b2c-dx.*` namespace. **You usually don't need to change any of them** — they exist for niche cases like disabling a feature you don't use, or quieting the log channel for a bug report. To browse: **Settings** (Cmd+,) → search for `b2c-dx`.
@@ -125,6 +115,6 @@ The B2C Script Debugger registers regardless of these toggles — it activates o
125115

126116
## Next Steps
127117

128-
- [Features](./features)full feature tour with per-feature credential callouts.
118+
- [Overview](./)what the extension can do.
129119
- [Authentication Setup](../guide/authentication) — Account Manager API clients, WebDAV access keys, OAuth scopes.
130120
- [CLI Configuration](../guide/configuration) — full `dw.json` reference and precedence rules.

docs/vscode-extension/features.md

Lines changed: 0 additions & 173 deletions
This file was deleted.
285 KB
Loading
55.6 KB
Loading
47.8 KB
Loading
363 KB
Loading
354 KB
Loading

0 commit comments

Comments
 (0)