Skip to content

docs(style): say which pages may pass the guide length limit - #654

Merged
aicayzer merged 1 commit into
mainfrom
docs/chunk2-length-rule
Oct 25, 2026
Merged

aicayzer merged 1 commit into
mainfrom
docs/chunk2-length-rule

Conversation

@aicayzer

Copy link
Copy Markdown
Contributor

Summary

STYLE.md limits 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

  • No code or page changed; pnpm test is unaffected.

Notes for reviewers

Checklist

  • Follows STYLE.md

@aicayzer aicayzer left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@aicayzer
aicayzer marked this pull request as ready for review October 25, 2026 17:21
@aicayzer
aicayzer merged commit 2779bda into main Oct 25, 2026
3 checks passed
@aicayzer
aicayzer deleted the docs/chunk2-length-rule branch October 25, 2026 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant