Repository navigation
feat(site): generate docs pages and cards from each mod's README - #33
Merged
Merged
Conversation
Each mod's docs page and home-page card is built from its README.md by a plain-Node generator (site/), with the sidebar, pager and cards built from one list (site/mods.json). The hand-written pages are deleted, and a GitHub Actions workflow builds and deploys the site, so a PR edits the README once instead of the README, its HTML page and every page's sidebar. All nine READMEs are rearranged into one layout (Quick start, Install, Use, Settings, Update, For developers), carrying over what only the hand-written pages said. The build checks each settings table against mod.schema.json and fails on broken links or Markdown it can't draw. Needs the Pages source switched to "GitHub Actions" before merging. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Important
Before merging, switch Settings → Pages → Build and deployment → Source to GitHub Actions. Until then the deleted docs pages 404 on the live site.
Summary
Docs pages and home-page cards are generated from each mod's README. A change edits the README once, not the README plus its HTML page plus every page's sidebar.
Every mod README now follows one layout, written up in
site/README.md:The READMEs pick up what only the hand-written pages said: Quick start, Update, settings tables, props/command tables. Where a page and its README disagreed, the code decided (e.g. Better Changes' diff tab is per space; Branch Issue worktrees start from the remote's default branch, not
main).Evidence
node --test */tests/*.test.cjs→ 391 pass.After: 404 pass. New checks:
node site/build.cjs, open_site/index.html): same page shell and style; the sidebar on the hand-written pages came out byte-identical.Merge Danger
Door: two-way
Revert the commit and switch the Pages source back to
main:/docs. The deleted HTML comes back with the revert.Blast Radius: docs site
preview.png.editorsas strings while the code reads objects; Branch Issue's schema says "Start work" where the button says "Create worktree".RECIPE.mdstill restates behaviour and changed in all six replayed PRs; it's now the biggest repeat.🤖 Generated with Claude Code