Skip to content

Remove the docs directory - #11622

Merged
caveman99 merged 1 commit into
developfrom
remove-docs-directory
Aug 27, 2026
Merged

Remove the docs directory#11622
caveman99 merged 1 commit into
developfrom
remove-docs-directory

Conversation

@caveman99

@caveman99 caveman99 commented Aug 26, 2026

Copy link
Copy Markdown
Member

The firmware design docs were published to meshtastic/meshtastic in #11488 and the directory was deleted. docs/bme680_iaq_replay.md re-added it.

AGENTS.md, CLAUDE.md and .github/copilot-instructions.md all state that documentation does not live in this repo and that docs/ must not come back. .coderabbit.yaml instructs review to flag any attempt to recreate it.

bin/bme680_iaq_replay.cpp carried 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 from trunk by .trunk/trunk.yaml.

Summary by CodeRabbit

  • Documentation
    • Updated replay tool build instructions with a repository-root compilation command.
    • Removed the standalone replay harness documentation.

@caveman99
caveman99 enabled auto-merge August 26, 2026 21:10
@caveman99
caveman99 requested a review from thebentern August 26, 2026 21:10
@coderabbitai

coderabbitai Bot commented Aug 26, 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: 1da5d782-7c92-47cb-a9ee-0e8b98bd0974

📥 Commits

Reviewing files that changed from the base of the PR and between 576a1bb and 9b4950e.

📒 Files selected for processing (2)
  • bin/bme680_iaq_replay.cpp
  • docs/bme680_iaq_replay.md
💤 Files with no reviewable changes (1)
  • docs/bme680_iaq_replay.md

Included review availability: Your plan provides up to 8 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The replay tool source comment now provides the repository-root C++17 build command. The standalone replay documentation file was deleted.

Changes

Replay tool documentation

Layer / File(s) Summary
Consolidate replay tool build instructions
bin/bme680_iaq_replay.cpp, docs/bme680_iaq_replay.md
The source comment adds the exact C++17 compilation command. The standalone replay harness documentation is deleted.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 9b495

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: thebentern

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the primary change: removal of the docs directory.
Description check ✅ Passed 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 chec…
Docstring Coverage ✅ Passed 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…
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.
Full details: Description check

Explanation

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 Coverage

Explanation

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
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch remove-docs-directory

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.

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

@caveman99 caveman99 added the cleanup Code cleanup or refactor label Aug 27, 2026
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.
@caveman99
caveman99 force-pushed the remove-docs-directory branch from 9b4950e to bb80ba4 Compare August 27, 2026 08:36
@caveman99
caveman99 added this pull request to the merge queue Aug 27, 2026
Merged via the queue into develop with commit 5b787fc Aug 27, 2026
58 of 60 checks passed
@caveman99
caveman99 deleted the remove-docs-directory branch August 27, 2026 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cleanup Code cleanup or refactor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants