Flip docs default to released + support doc-only releases#177
Open
Flip docs default to released + support doc-only releases#177
Conversation
Add a private @salesforce/b2c-dx-docs workspace package to enable: - Doc-only releases via changesets without bumping CLI/SDK/MCP versions - Automatic docs rebuild when SDK changes (via updateInternalDependencies cascade) - Changelog tracking for documentation changes Flip the docs deployment so released/stable docs are served at the root URL and dev docs live at /dev/. Previously dev was at root and released docs were at /release/. Update deploy-docs workflow to build stable docs at root from the latest tag (matching both @salesforce/* and docs@* patterns) and nest dev docs under /dev/. Update publish workflow to create docs@<version> tags and trigger docs deployment on stable releases.
Document the docs workspace package in the monorepo package listing, Documentation section (build modes, URL structure, doc-only releases, SDK cascade), and Changesets section.
Runs on PRs that touch docs/ or SDK source (which affects TypeDoc API docs generation). Catches broken docs builds before merge.
Add a docs build step to ci.yml after package builds instead of a separate docs-ci workflow. Reuses the existing checkout, install, and build steps — more efficient than spinning up a separate runner.
Move vitepress, typedoc, and typedoc plugins from root devDependencies into docs/package.json. Move typedoc.json into docs/ with adjusted relative paths. Root package.json scripts now proxy to the docs package via pnpm --filter.
Add explicit list of valid changeset packages to AGENTS.md and note doc-only changeset guidance. Set docs package version to 0.1.0 to align with the pre-GA versioning of the other packages.
patricksullivansf
approved these changes
Feb 20, 2026
Contributor
patricksullivansf
left a comment
There was a problem hiding this comment.
conceptually this makes sense.
I'm a little confused about how often the dev docs get built by CI
Collaborator
Author
|
They are built on every change to |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
/dev/(previously dev was at root, released at/release/)@salesforce/b2c-dx-docsworkspace package to enable doc-only releases and changelog trackingWhy a docs workspace package?
Adding a private
@salesforce/b2c-dx-docspackage to the monorepo with a dependency on@salesforce/b2c-tooling-sdkgives us three benefits via the existing changeset infrastructure:Doc-only releases — Documentation improvements can be released independently by creating a changeset that only bumps
@salesforce/b2c-dx-docs. This creates adocs@<version>tag and triggers a docs rebuild without touching CLI/SDK/MCP versions.Automatic cascade on SDK changes — Because the docs package depends on the SDK, the
updateInternalDependencies: "patch"setting in changeset config auto-bumps the docs version whenever the SDK is bumped. This is correct behavior since API docs are generated from the SDK and should be rebuilt when it changes.Changelog tracking — Doc changes get their own
CHANGELOG.mdand appear in GitHub release notes, providing visibility into what changed in the documentation.Release cascade behavior:
Changes
docs/package.jsonpnpm-workspace.yamldocsto workspace packagesdocs/.vitepress/config.mtsIS_RELEASE_BUILD→IS_DEV_BUILD, stable at root, dev at/dev/.github/workflows/deploy-docs.yml@salesforce/*+docs@*),cancel-in-progress: true.github/workflows/publish.ymldocs@<version>tag creation, changelog extraction, deploy trigger.github/workflows/ci.ymlTest plan
pnpm installsucceeds with new docs workspacepnpm -r run buildskips docs package (no build script)pnpm run docs:build(default) produces root-path stable docsIS_DEV_BUILD=true pnpm run docs:buildproduces/dev/base pathpnpm run lint:agentpassespnpm run typecheck:agentpassespnpm changeset version