Skip to content

docs(cli): document the msw config command family - #24

Merged
larsrollik merged 2 commits into
mainfrom
docs/config-cli
Aug 14, 2026
Merged

docs(cli): document the msw config command family#24
larsrollik merged 2 commits into
mainfrom
docs/config-cli

Conversation

@larsrollik

Copy link
Copy Markdown
Member

Adds a CLI Reference page for msw configshow, upgrade, and migrate-subjects — and wires it into the mkdocs nav (it was the one command family with no reference page).

Key clarification in the upgrade section: it materialises new bundled keys into your config-dir overlay for visibility/version-control, but is not required for new keys to take effect — the runtime overlay chain already deep-merges over the bundled defaults, so any unset key is inherited automatically (consistent with the Config Overlays how-to).

Builds clean under mkdocs build --strict.

Adds a CLI Reference page for 'msw config' (show / upgrade / migrate-subjects)
and wires it into the nav. Clarifies that 'config upgrade' materialises new
bundled keys into overlays for visibility - runtime already inherits them via
the deep-merge overlay chain, so it is not required for new keys to take effect.
@larsrollik
larsrollik merged commit c253bdd into main Aug 14, 2026
8 checks passed
@larsrollik
larsrollik deleted the docs/config-cli branch August 14, 2026 07:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant