You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+28-3Lines changed: 28 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,7 @@ This is a monorepo project with the following packages:
4
4
-`./packages/b2c-cli` - the command line interface built with oclif
5
5
-`./packages/b2c-tooling-sdk` - the SDK/library for B2C Commerce operations; supports the CLI and can be used standalone
6
6
-`./packages/b2c-dx-mcp` - Model Context Protocol server; also built with oclif
7
+
-`./docs` - documentation site (private `@salesforce/b2c-dx-docs` workspace package; not published to npm)
7
8
8
9
## Common Commands
9
10
@@ -97,10 +98,33 @@ See [documentation skill](./.claude/skills/documentation/SKILL.md) for details o
97
98
# Run docs dev server (from project root)
98
99
pnpm run docs:dev
99
100
100
-
# Build docs for production
101
+
# Build docs for production (stable mode — root base path)
101
102
pnpm run docs:build
103
+
104
+
# Build docs in dev mode (/dev/ base path)
105
+
IS_DEV_BUILD=true pnpm run docs:build
102
106
```
103
107
108
+
### Docs workspace package
109
+
110
+
The `./docs` directory is a private workspace package (`@salesforce/b2c-dx-docs`) with a dependency on `@salesforce/b2c-tooling-sdk`. This exists to support doc-only releases and changelog tracking via changesets, not for npm publishing. It has no build script — `pnpm -r run build` skips it.
111
+
112
+
**Deployed URL structure:** stable/released docs are served at the root URL, dev docs (from `main`) live at `/dev/`.
113
+
114
+
**Doc-only releases:** to release documentation changes without bumping CLI/SDK/MCP, create a changeset that targets only the docs package:
115
+
116
+
```md
117
+
---
118
+
'@salesforce/b2c-dx-docs': patch
119
+
---
120
+
121
+
Improved authentication guide with step-by-step examples
122
+
```
123
+
124
+
This produces a `docs@<version>` tag and triggers a docs rebuild on merge of the version PR.
125
+
126
+
**Automatic cascade:** because the docs package depends on the SDK, when the SDK version is bumped by a changeset, `updateInternalDependencies: "patch"` auto-bumps the docs version too — triggering a docs rebuild (correct since API docs are generated from the SDK).
127
+
104
128
## Logging
105
129
106
130
- when logging use the logger instance from `@salesforce/b2c-tooling-sdk/logger` package
@@ -142,8 +166,9 @@ This project uses [Changesets](https://github.com/changesets/changesets) for ver
142
166
143
167
**How it works:**
144
168
- A changeset affecting only the SDK bumps only the SDK version
145
-
- Packages that depend on a bumped package get an automatic patch bump (via `updateInternalDependencies: "patch"`) — e.g., if SDK bumps, CLI and MCP auto-get a patch bump because they depend on it
146
-
- Only packages with a newer version than what's on npm get published
169
+
- Packages that depend on a bumped package get an automatic patch bump (via `updateInternalDependencies: "patch"`) — e.g., if SDK bumps, CLI, MCP, and Docs all auto-get a patch bump
170
+
- Only packages with a newer version than what's on npm get published (docs package is private and uses git tags instead)
171
+
- A changeset targeting only `@salesforce/b2c-dx-docs` triggers a doc-only release — no npm packages are published, just a `docs@<version>` tag and docs rebuild
147
172
148
173
Changeset guidelines:
149
174
- Create a changeset for any user-facing changes (features, bug fixes); typically in new pull requests
0 commit comments