Add agent guideline: documentation belongs in the docs repo - #11492
Conversation
⚡ Try this PR in the Web FlasherNote Building this pull request… the flash button, badges and supported-board |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughThe pull request adds documentation-placement and writing policies to review configuration and repository guidance files. The policies direct valid documentation to the upstream Meshtastic documentation repository and prohibit local narrative Markdown content. ChangesDocumentation policy
Estimated code review effort: 2 (Simple) | ~10 minutes Mergeability Score: ⚪ Minimal · up to This change only updates repository guidance and documentation review rules; no actionable merge-blocking risk remains after normal checks and review. Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Mirrored in AGENTS.md, .github/copilot-instructions.md and CLAUDE.md, with a matching CodeRabbit path instruction for **/*.md.
86cec96 to
7320b2d
Compare
This repo holds code. Documentation belongs in meshtastic/meshtastic. No
docs/directory (deleted in #11488), no new.mdfiles for features, APIs or designs, no write-ups left in the tree. Upstream docs read as a technical manual, not a narrative.Mirrored across
AGENTS.md,.github/copilot-instructions.mdandCLAUDE.md, plus a.coderabbit.yamlpath instruction for**/*.mdso it is enforced at review time.Scoped to new documentation files; the existing README/CONTRIBUTING/SECURITY,
.github/prompts/*, and hardware notes undervariants/andsrc/graphics/are untouched.Attestations
Documentation only, no firmware code changed.
trunk fmtclean.Summary by CodeRabbit