Conversation
The repository asks for community documentation help but gives an arriving contributor nothing to work from: no page conventions, no vocabulary rules, no way to check their own work before opening a PR. CONTRIBUTING.md documents what the repo actually does — page shape, screenshot handling and the ScreenshotFigure props, how the two locales relate, and one rule worth stating plainly: never document a command without running it, because the bot's built-in help has been out of date. The workflow runs `npm run docs:build` on every pull request. VitePress fails the build on dead internal links, so this gates every future community PR on link integrity without anyone reviewing it by hand. Co-Authored-By: Claude Opus 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
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.
You asked the community for documentation help and said you lack the time to do it all yourself. This PR is aimed at the part of that problem you can't solve by writing more docs: the review burden that community PRs create.
CONTRIBUTING.mdSomeone willing to help currently arrives at a repo with no stated conventions. This documents what the repo already does, rather than inventing rules: the shape of a page, the screenshot folder layout and the
ScreenshotFigureprops, how the English and Portuguese locales relate, and how to check your own work before opening a PR.It also states one rule plainly, because it is the mistake that costs you the most to catch by hand: never document a command without running it. The bot's built-in
/helpcurrently omits five commands that exist and lists two that do not, so it is not a safe source..github/workflows/docs.ymlRuns
npm run docs:buildon every pull request and on pushes tomaster. Node 20, npm cache, nothing else.The reason this is worth having: VitePress fails the build on dead internal links. So this is not just a build check — it is an automatic link-integrity gate on every contribution, including mine, that costs you no review time. A PR that breaks a link goes red before you open it.
Scope: three files, none of them documentation pages. Independent of my other PRs — merging this first means every later PR arrives already checked.
Written with AI assistance; the conventions were derived by reading the repository rather than assumed.
🤖 Generated with Claude Code