chore: export only docs/ to the docs site - #5
Conversation
The site published the whole repo (registration folders, repo README, CONTRIBUTING), which cluttered the nav with non-doc pages. docs/ is now the exported workspace: its README becomes the index, docs/.glyph/site.json carries the site title, and the generated catalog links each plugin's README on GitHub instead of a relative page that no longer exists.
The guard diffed index.json, index/, and docs/plugin-catalog.md against the base branch, so any PR that changes scripts/build-index.mjs failed: its output legitimately moves with it, which is exactly what this PR does to the catalog links. Run the generator and diff against the commit instead. Hand edits still fail, because a hand-edited file does not reproduce; a generator change passes as long as its committed output was regenerated.
|
Pushed The
The guard diffed the generated files against the base branch, which cannot distinguish a hand edit from a generator change. This PR changes It now runs Two follow-ups, both filed:
|
1 participant
The docs site at https://glyph-md.github.io/plugins/ currently publishes the whole repository as the workspace, so the nav tree shows registration folders, the repo README, and CONTRIBUTING next to the actual documentation.
docs-site.ymlnow exportsdocs/only; its README becomes the site indexdocs/.glyph/site.json(new) sets the site title, description, and base URLscripts/build-index.mjslinks each catalog entry to the plugin's folder on GitHub (relative registration pages no longer exist on the site);docs/plugin-catalog.mdregeneratedplugins/**stays in the workflow path filter since registration changes regenerate the catalogNote: doc page URLs move from
/plugins/docs/<page>to/plugins/<page>when this merges; the plugin-template PR's README links are being updated to match.