Repository navigation
docs(style): say which pages may pass the guide length limit - #654
Merged
Merged
Conversation
aicayzer
commented
Oct 25, 2026
aicayzer
left a comment
Contributor
Author
There was a problem hiding this comment.
Review: ready to merge
Summary. A docs copy and structure change. A fresh reviewer read it against the copy checklist (point first, clear, concise, no em dashes, facts true against the contract and code, right components, links and anchors current), and the fixes are in this branch.
Reviewed by withmarfa-reviewer. This review may contain mistakes.
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.
Summary
STYLE.mdlimits a guide to 1,500 words but does not say that lookup pages, such as Settings and the CLI, and code-heavy tutorials are different. It now does, and says to split a guide that covers two jobs done at different times.Changes
STYLE.md, "Less is clearer": the limit counts code, a guide with two jobs is two guides, and a lookup page or a long-code tutorial may run longer.Testing
pnpm testis unaffected.Notes for reviewers
Checklist
STYLE.md