[tidy] tying up some loose ends - #11292
Conversation
📝 WalkthroughWalkthroughUpdates node storage and traffic-management documentation with memory-tier capacities, persistence and eviction rules, cache invariants, and tick-clock wrap-safety details. Removes the Gitpod initialization command that installed PlatformIO and upgraded ChangesDocumentation and workspace cleanup
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/node_info_stores.md (1)
64-70: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winLabel the ESP32-S3 flash thresholds directly in the capacity table.
250 / 200 / 100is only explained indirectly by the later>=15 MB / >=7 MB / smallerprose. Use explicit columns for those thresholds, or add a legend, so platform selection cannot be misread.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/node_info_stores.md` around lines 64 - 70, Clarify the ESP32-S3 row in the capacity table by directly associating 250, 200, and 100 with the flash-chip thresholds of >=15 MB, >=7 MB, and smaller, using explicit columns or a nearby legend. Keep the existing capacity values and platform mappings unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/node_info_stores.md`:
- Around line 227-234: Update the node-info cache enable/sweep path so entries
with stale or potentially aliased obsTick values are invalidated or re-saturated
before serving NodeInfo after traffic management is re-enabled; use
maintainNodeInfoCacheLocked() and runOnce() as the relevant
maintenance/enable-flow symbols. Document the cross-disable/re-enable
wrap-safety guarantee at docs/node_info_stores.md lines 227-234 and
docs/traffic_management_module.md lines 196-200, or ensure the implementation
directly clears the stale state before it reaches the serve path.
---
Nitpick comments:
In `@docs/node_info_stores.md`:
- Around line 64-70: Clarify the ESP32-S3 row in the capacity table by directly
associating 250, 200, and 100 with the flash-chip thresholds of >=15 MB, >=7 MB,
and smaller, using explicit columns or a nearby legend. Keep the existing
capacity values and platform mappings unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 7a1c8cdd-7e3b-48ac-b89c-bce89a313668
📒 Files selected for processing (3)
.gitpod.ymldocs/node_info_stores.mddocs/traffic_management_module.md
💤 Files with no reviewable changes (1)
- .gitpod.yml
There was a problem hiding this comment.
Pull request overview
Note
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Updates documentation for node info stores and the traffic management module, clarifying how cache sizing depends on memory class/platforms and centralizing tick-clock/wrap-safety details.
Changes:
- Added/expanded memory class and cache capacity tables in
node_info_stores.md. - Moved and expanded tick clock / wrap-safety explanation into
traffic_management_module.md. - Removed the Gitpod init task (leaving
.gitpod.ymlempty).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/traffic_management_module.md | Adds a centralized “Tick clocks and wrap safety” section and links back to node-info store details. |
| docs/node_info_stores.md | Introduces “Memory classes” plus expanded capacity tables and updates the store comparison table. |
| .gitpod.yml | Removes init tasks (resulting in an empty config file). |
⚡ Try this PR in the Web Flasher
Warning This is an automated, unreviewed CI test build. Back up your device configuration Supported boards built by this PR (31)
Build artifacts expire on 2026-08-29. Updated for |
This pull request updates the documentation for node info stores and the traffic management module to clarify memory classing, cache sizing, and timestamp wrap safety. The changes provide more detailed and accurate explanations of how cache capacities are determined per platform, add tables for memory classes and cache sizes, and move technical details about tick clocks to a central location. Minor corrections and clarifications are also made to improve consistency.
Documentation improvements:
node_info_stores.md, explaining how cache sizes are determined byMESHTASTIC_MEM_CLASSand providing a table of memory classes and their corresponding heap sizes and platforms.Timestamp and tick clock documentation:
node_info_stores.mdto a new dedicated section intraffic_management_module.md, with a detailed table of tick periods, windows, and maintenance mechanisms. [1] [2]Other changes:
pip installtask from.gitpod.ymlas it is no longer needed.These updates make the documentation more accurate, easier to understand, and more useful for developers working with node info stores and traffic management internals.
🤝 Attestations
Summary by CodeRabbit