Changelog Process¶
Goal¶
Keep docs changes aligned with released behavior and tenant rollouts.
Required Inputs Per Docs Release¶
- Release tag (
vX.Y.Z) - Summary of changed customer/company/association behavior
- Updated screenshots or examples when UI changes materially
- Known limitations and rollout caveats
Minimum Changelog Entry¶
For each tenant/persona page updated, include:
- What changed
- Why it changed
- Effective version (
X.Y) - Any backward compatibility note
Operational Checklist¶
- Update affected markdown pages with metadata and content
- Run local validation (
mkdocs build --strict) - Publish version (
publish-docs-version.sh) - Verify version aliases and default
- Smoke test
https://docs.cfhub.net