Skip to content

docs: improve Claude rules structure and review skill#2259

Draft
marcel-rbro wants to merge 5 commits intomasterfrom
docs/improve-claude-rules
Draft

docs: improve Claude rules structure and review skill#2259
marcel-rbro wants to merge 5 commits intomasterfrom
docs/improve-claude-rules

Conversation

@marcel-rbro
Copy link
Contributor

@marcel-rbro marcel-rbro commented Feb 18, 2026

Summary

  • Extract grammar rules from writing-style.md into dedicated grammar-rules.md for clearer separation of concerns
  • Restructure review-docs skill to delegate style compliance checking to subagents that read rules files directly, decoupling the skill from specific rule content
  • Align descriptions across README.md, instructions.md, and SKILL.md for consistency

Test plan

  • Verify npm run lint:md passes on all changed files
  • Test /review-docs skill on a sample documentation file to confirm subagent delegation works
  • Confirm all rules files are referenced consistently across README, instructions, and skill files

🤖 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 trimming writing-style.md to 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-docs skill is reworked to delegate style compliance checks per rules file (via subagents) and to separate that from a smaller manual content/accuracy checklist; README.md and instructions.md are aligned to reflect the new rules structure.

Written by Cursor Bugbot for commit 22b4f63. Configure here.

@github-actions github-actions bot added the t-docs Issues owned by technical writing team. label Feb 18, 2026
@apify-service-account
Copy link

Preview for this PR was built for commit 95d4737a and is ready at https://pr-2259.preview.docs.apify.com!

@marcel-rbro marcel-rbro requested a review from TC-MO February 18, 2026 17:53
@marcel-rbro marcel-rbro marked this pull request as ready for review February 18, 2026 17:55
@apify-service-account
Copy link

Preview for this PR was built for commit 22b4f636 and is ready at https://pr-2259.preview.docs.apify.com!

@marcel-rbro marcel-rbro marked this pull request as draft February 25, 2026 10:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

t-docs Issues owned by technical writing team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants