Repository navigation
docs: give the README what CI actually gates - #145
Merged
Merged
Conversation
The README listed four commands. CI gates five, and none of the four overlapped with the ones that fail a pull request, so a contributor met check:images or check:anchors for the first time as a red build. - document lint, check:images, check:anchors and check:app-links, each with a line on what it enforces and a pointer to the script header that explains why it exists - document the three branch model. main, develop and bugfixes publish stable, latest and patch simultaneously, and nothing in the repo said so or said which one to target - add prerequisites: node from .nvmrc, pnpm via corepack - say what the repository is and link the published site - split "Build and Preview" in two. preview only serves the last build, so the old heading promised something the command does not do - tag the code fences sh, and point at contribution-guides for the writing conventions
This branch was successfully deployed
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.
Follow-up to #144. The README listed four commands; CI gates five, and the two sets barely overlapped.
Why
A contributor adding a page currently meets
check:images("every image must be owned by a page") for the first time as a red build, because nothing outsideci.ymlmentions it. Same forcheck:anchorsandcheck:app-links, which are unusual enough that the failure message alone does not tell you what the convention is.The bigger gap is the branch model.
main,developandbugfixespublish stable, latest and patch simultaneously, and nothing in the repo said so. Picking a target branch is the first decision a contributor has to make, and until now it required readingdeploy-docs.yml.Changes
contribution-guides/releasing.md..nvmrc, pnpm viacorepack enable.Build and Previewsplit in two.pnpm run previewonly serves whatbuildlast wrote, so the old heading promised something the command does not do.sh; pointer tocontribution-guides/for writing conventions.Notes
The README is excluded from the site build (
srcExclude) and from all three checker scripts (SKIP_FILES), so it is purely repo-facing and the relative links target GitHub rather than the rendered site. I verified every path it links to exists.Content only, no dependency or config changes.
pnpm lint,pnpm build,check:images,check:anchorsandcheck:app-linksall pass.