Remove the docs directory - #11622
Conversation
|
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 (2)
💤 Files with no reviewable changes (1)
Included review availability: Your plan provides up to 8 included reviews per hour; 3 remain after this review. 📝 WalkthroughWalkthroughThe replay tool source comment now provides the repository-root C++17 build command. The standalone replay documentation file was deleted. ChangesReplay tool documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk: ⚪ Minimal · up to This localized change removes the prohibited documentation directory and keeps the replay harness reference aligned without changing firmware behavior. No actionable merge-blocking risk remains beyond normal checks and review. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Description checkExplanation The description is detailed, on-topic, and explains the documentation move, the source comment update, and the absence of functional changes. It does not include the template’s formal attestation checklist, but the main required change information is present. Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1 files. ✨ Finishing Touches📝 Generate docstrings
🧪 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 |
⚡ Try this PR in the Web FlasherNote Building this pull request… the flash button, badges and supported-board |
The firmware design docs were published to meshtastic/meshtastic in #11488 and the directory was deleted. bme680_iaq_replay.md re-added it. The replay harness build command moves into the header comment of bin/bme680_iaq_replay.cpp, the only file that referenced the document.
9b4950e to
bb80ba4
Compare
The firmware design docs were published to meshtastic/meshtastic in #11488 and the directory was deleted.
docs/bme680_iaq_replay.mdre-added it.AGENTS.md,CLAUDE.mdand.github/copilot-instructions.mdall state that documentation does not live in this repo and thatdocs/must not come back..coderabbit.yamlinstructs review to flag any attempt to recreate it.bin/bme680_iaq_replay.cppcarried the only reference to the document. Its build command moves into that file's header comment, so the replay harness stays usable without a separate document. The remaining content (input format, trace capture on a BSEC build, output columns) belongs in the docs repo if it is wanted.No functional change.
bin/is excluded fromtrunkby.trunk/trunk.yaml.Summary by CodeRabbit