📜 Render the workspace changelog as a docs page#163
Merged
Conversation
Add a Changelog page fed by the synced workspace CHANGELOG.md via the house data→generator→partial pattern: - generate-changelog.mjs strips the git-cliff '# Changelog' header into a gitignored docs/partials/changelog.md (placeholder when unsynced). - docs/changelog.md host page owns frontmatter + heading + the include. - registered in generate-all.mjs; nav + sidebar entries added. - seed .vitepress/data/CHANGELOG.md with the first arrival. No lint-ignore: the workspace .cliff.toml now emits markdownlint-clean output, so the synced data lints as a normal tracked file.
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
1 participant
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.
Part 3/3 of 2026-q2-50 public-release-surface (ws-docs leg). Depends on the workspace + ws-meta PRs (which route the synced
CHANGELOG.mdhere).Adds a public Changelog page, fed by the synced
workspace/CHANGELOG.mdthrough the house data→generator→partial pattern.Changes
scripts/generate-changelog.mjs(new) — strips git-cliff's# Changelogheader from.vitepress/data/CHANGELOG.mdinto a gitignoreddocs/partials/changelog.md(graceful placeholder when the data file isn't synced yet). Mirrorsgenerate-fs-manifest.mjs.scripts/generate-all.mjs— register the generator (runs onprebuild).docs/changelog.md(new) — thin hand-authored host page (frontmatter + heading +@includeof the partial). Normally linted.docs/partials/.gitignore— addchangelog.md(generated, like every other partial)..vitepress/_nav.ts+_sidebar.ts— add theChangelogentry..vitepress/data/CHANGELOG.md— seed the first arrival.No lint-ignore
The
workspace.cliff.tomlnow emits markdownlint-clean output (companion PR), so the synced data file lints as a normal tracked file — no.markdownlintignoreand no.prettierignore(prettier isn't in this repo's toolchain). Fullpre-commit run --all-filesis green;docs:buildrenders the page (v0.4.0 → v0.2.0).Placement
/changelog(root-level top-level segment) — a standalone reference surface, peer to/editor,/tools; not nested under/pages(intro prose). Nelson-confirmed.