docs: improve Claude rules structure and review skill#2259
Draft
marcel-rbro wants to merge 5 commits intomasterfrom
Draft
docs: improve Claude rules structure and review skill#2259marcel-rbro wants to merge 5 commits intomasterfrom
marcel-rbro wants to merge 5 commits intomasterfrom
Conversation
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
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
writing-style.mdinto dedicatedgrammar-rules.mdfor clearer separation of concernsreview-docsskill to delegate style compliance checking to subagents that read rules files directly, decoupling the skill from specific rule contentREADME.md,instructions.md, andSKILL.mdfor consistencyTest plan
npm run lint:mdpasses on all changed files/review-docsskill on a sample documentation file to confirm subagent delegation works🤖 Generated with Claude Code
Note
Low Risk
Docs-only changes that adjust writing/review guidance and rule organization; low risk beyond potential reviewer confusion if downstream tooling assumes the old rules layout.
Overview
Reorganizes Claude doc standards by extracting grammar mechanics into a new auto-loaded
grammar-rules.md, and trimmingwriting-style.mdto focus on voice/tone with pointers to the other rules.Updates the canonical rules to tighten and clarify standards (e.g., heading hierarchy assumes H1 comes from front matter, avoid em dashes, link external tool mentions, and add specific article-usage guidance for Apify product names). The
/review-docsskill is reworked to delegate style compliance checks per rules file (via subagents) and to separate that from a smaller manual content/accuracy checklist;README.mdandinstructions.mdare aligned to reflect the new rules structure.Written by Cursor Bugbot for commit 22b4f63. Configure here.