Skip to content

Add agent guideline: documentation belongs in the docs repo - #11492

Merged
caveman99 merged 1 commit into
developfrom
no-docs-in-repo
Aug 14, 2026
Merged

Add agent guideline: documentation belongs in the docs repo#11492
caveman99 merged 1 commit into
developfrom
no-docs-in-repo

Conversation

@caveman99

@caveman99 caveman99 commented Aug 13, 2026

Copy link
Copy Markdown
Member

This repo holds code. Documentation belongs in meshtastic/meshtastic. No docs/ directory (deleted in #11488), no new .md files 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.md and CLAUDE.md, plus a .coderabbit.yaml path instruction for **/*.md so it is enforced at review time.

Scoped to new documentation files; the existing README/CONTRIBUTING/SECURITY, .github/prompts/*, and hardware notes under variants/ and src/graphics/ are untouched.

Attestations

  • I have tested that my proposed changes behave as described.
  • I have tested that my proposed changes do not cause any obvious regressions on the following devices:
    • Other (please specify below)

Documentation only, no firmware code changed. trunk fmt clean.

Summary by CodeRabbit

  • Documentation
    • Updated project guidance to keep feature, API, protocol, design, migration, and investigative documentation in the upstream documentation repository.
    • Added review guidance to identify misplaced, non-technical, or redundant documentation.
    • Clarified that valid documentation should follow a concise, factual, technical-manual style and be linked from the related change.

@github-actions

Copy link
Copy Markdown
Contributor

⚡ Try this PR in the Web Flasher

Note

Building this pull request… the flash button, badges and supported-board
list will appear here automatically once CI finishes.

@coderabbitai

coderabbitai Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 52e07ee2-497c-4e7f-bdb5-dc9be2c1af61

📥 Commits

Reviewing files that changed from the base of the PR and between 6745995 and 86cec96.

📒 Files selected for processing (4)
  • .coderabbit.yaml
  • .github/copilot-instructions.md
  • AGENTS.md
  • CLAUDE.md

📝 Walkthrough

Walkthrough

The 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.

Changes

Documentation policy

Layer / File(s) Summary
Define documentation placement rules
.coderabbit.yaml, .github/copilot-instructions.md, AGENTS.md, CLAUDE.md
Review instructions and repository guidance prohibit local documentation and direct valid technical documentation to the upstream repository. They define prohibited content and require concise, factual technical-manual style.

Estimated code review effort: 2 (Simple) | ~10 minutes

Mergeability Score: ⚪ Minimal · up to 86cec

This change only updates repository guidance and documentation review rules; no actionable merge-blocking risk remains after normal checks and review.

Possibly related PRs

  • meshtastic/firmware#11488: Removes local documentation and updates references while directing documentation to the upstream site.

Suggested labels: cleanup

Suggested reviewers: nomdetom, thebentern, vidplace7

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: adding guidance that documentation belongs in the upstream docs repository.
Description check ✅ Passed The description explains the guideline changes, scope, testing, and documentation-only nature of the pull request.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch no-docs-in-repo

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@caveman99 caveman99 added cleanup Code cleanup or refactor Compliance labels Aug 13, 2026
@caveman99
caveman99 enabled auto-merge August 13, 2026 16:25
Mirrored in AGENTS.md, .github/copilot-instructions.md and CLAUDE.md, with a
matching CodeRabbit path instruction for **/*.md.
@caveman99
caveman99 added this pull request to the merge queue Aug 14, 2026
Merged via the queue into develop with commit 4d52432 Aug 14, 2026
62 checks passed
@caveman99
caveman99 deleted the no-docs-in-repo branch August 14, 2026 10:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cleanup Code cleanup or refactor Compliance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant