chore: export only docs/ to the docs site - #5
Open
hamidfzm wants to merge 2 commits into
Open
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.
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.
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.