Skip to content

docs: Reticulum ownership layers and RF-mesh protocol scope - #842

Merged
rinchen merged 3 commits into
mainfrom
docs
Aug 12, 2026
Merged

rinchen merged 3 commits into
mainfrom
docs

Conversation

@rinchen

@rinchen rinchen commented Aug 12, 2026

Copy link
Copy Markdown
Member

Summary

  • Document RNS vs LXMF-client vs mesh-client policy ownership so sidecar/UI automation is not mistaken for Reticulum transport.
  • State product protocol scope: additional protocols need an RF mesh path; internet-only stacks are out of scope; ham protocols welcome under that bar; Mesh-Client is for everyone, everywhere.
  • Cross-link ownership from Path routing, agent reticulum notes, and AGENTS.md.

Test plan

  • Skim docs/reticulum.md Architecture → Ownership section (mermaid + tables render)
  • Confirm README / CONTRIBUTING / docs index protocol-scope wording matches intent
  • Confirm AGENTS.md and docs/agents/reticulum.md links resolve to the ownership anchor

Summary by CodeRabbit

  • Documentation
    • Clarified that Mesh-Client focuses on RF mesh networking while permitting compatible amateur-radio protocols and excluding internet-only messaging stacks.
    • Documented responsibility boundaries between transport, messaging behavior, and product-level mesh policies.
    • Added guidance on routing failover, medium preference, and automatic demotion.
    • Updated contribution and agent guidance with protocol scope and automation ownership rules.

Document RNS vs LXMF-client vs mesh-client policy so automation is not mistaken for transport, and state that additional protocols need an RF mesh path while remaining open to everyone.
@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@rinchen, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 53 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: QUIET

Plan: Pro Plus

Run ID: 3d197446-d2e1-46d6-a0cf-7c72ef130fe1

📥 Commits

Reviewing files that changed from the base of the PR and between c815caa and bf342b4.

📒 Files selected for processing (2)
  • README.md
  • docs/index.md
📝 Walkthrough

Walkthrough

The PR adds protocol-scope guidance and documents ownership boundaries between RNS transport, LXMF sidecar behavior, and mesh-client policy.

Changes

Protocol scope and Reticulum ownership

Layer / File(s) Summary
Protocol scope guidance
CONTRIBUTING.md, README.md, docs/index.md
The documentation defines RF mesh networking as the project focus, permits compatible amateur-radio and additional protocols, allows internet transports alongside RF, and excludes internet-only messaging stacks.
Reticulum ownership and policy boundaries
AGENTS.md, docs/agents/reticulum.md, docs/reticulum.md
The documentation assigns transport and pathfinding to RNS, LXMF client and propagation-node behavior to the sidecar, and routing automation such as failover, medium preference, Auto-demotion, and DM probes to mesh-client policy.

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

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main changes: Reticulum ownership boundaries and RF-mesh protocol scope.
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
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 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 `@README.md`:
- Line 40: Update README.md line 40 and docs/index.md line 21 to use one
canonical protocol-scope statement: require an RF mesh path, exclude
internet-only stacks, allow shipped protocols to supplement RF with internet
transports, consider additional protocols meeting the RF-mesh requirement,
welcome compatible ham protocols, and state that Mesh-Client is for everyone.
Preserve the existing audience wording in both documents.
🪄 Autofix

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

Plan: Pro Plus

Run ID: f2ad345c-ad73-4214-a0a7-222cd5d7f33f

📥 Commits

Reviewing files that changed from the base of the PR and between 5e0c265 and c815caa.

📒 Files selected for processing (6)
  • AGENTS.md
  • CONTRIBUTING.md
  • README.md
  • docs/agents/reticulum.md
  • docs/index.md
  • docs/reticulum.md

Comment thread README.md Outdated
Use the same RF-mesh eligibility contract everywhere, including internet transports alongside RF for shipped protocols.
@rinchen
rinchen merged commit f1e04e6 into main Aug 12, 2026
12 checks passed
@rinchen
rinchen deleted the docs branch August 12, 2026 03:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant