Skip to content

docs: strip internal plan/roadmap numbering from user-facing docs - #124

Merged
M0LTE merged 1 commit into
masterfrom
docs/strip-plan-numbering
May 5, 2026
Merged

docs: strip internal plan/roadmap numbering from user-facing docs#124
M0LTE merged 1 commit into
masterfrom
docs/strip-plan-numbering

Conversation

@M0LTE

@M0LTE M0LTE commented May 5, 2026

Copy link
Copy Markdown
Collaborator

Summary

User-facing docs had leftover references to the development plan numbering (F1/F2/F3/F4, B5/B6.1/B6.2, Phase 1/2/2b, Phase H, Phase F3). These codes are meaningful inside `plan.md` but not to a reader of the published manual.

Replaced each with a descriptive name; substantive content unchanged:

  • F1 -> "source tracking" / removed where redundant
  • F2 -> "multi-part" / "fragmentation"; glossary entry merged into the existing fragment entry
  • F3 -> just "rev" / "polling"; glossary entry removed (content already in rev)
  • F4 -> versioning policy; glossary entry removed (covered by the DAPPSv1 entry)
  • B6.1 -> removed (it's just connected-mode probing)
  • B6.2 -> removed (it's just solicit-and-listen)
  • Phase 1 / Phase 2 / Phase 2b probe flavours -> direct / transitive / node-prompt
  • Phase H links to plan.md -> "on the roadmap" with link to `connect/meshcore.md`

8 files touched, 29 insertions, 37 deletions.

Test plan

  • `grep -rE '\bF[1-4]\b|\bB[5-7]\b|Phase [A-Z0-9]|Plan [A-Z0-9]'` clean across published docs (excluding the engineering-note files `routing-prior-art.md` and `meshcore-backhaul-routing.md` which are already excluded from the mkdocs site)
  • `mkdocs build --strict` clean
  • No file:line citations broken (`implement.md` still cites canonical source files)
  • Glossary entries that were removed have their content covered by other entries (`fragment`, `rev`, `DAPPSv1`)

🤖 Generated with Claude Code

The user-facing docs had remnants of the development plan numbering
scheme (F1/F2/F3/F4 for source-tracking/fragmentation/polling/
versioning, B5/B6.1/B6.2 for routing/probing/solicits, Phase 1/2/2b
for the probe rollout, Phase H for the MeshCore bearer roadmap, Phase
F3 for the rev command). These codes are meaningful inside plan.md
but not to the reader of the published manual.

Replaced each with a descriptive name and kept the substantive
content intact:

- F1 / Phase F3 / "Forwarders that don't speak F1" -> source-tracking
  / rev / "forwarders that don't propagate it"
- F2 / "pre-F2 receiver" -> multi-part fragmentation / "receiver
  that doesn't know mid/frag"
- F3 / F4 entries removed from glossary; their content is already
  covered under "rev" and the DAPPSv1 versioning paragraph.
- B6.1 -> dropped (it's just connected-mode probing).
- B6.2 -> dropped (it's just solicit-and-listen).
- Phase 1 / Phase 2 / Phase 2b probe flavours -> direct / transitive
  / node-prompt.
- Phase H links -> just "on the roadmap" / link to connect/meshcore.md.

mkdocs --strict build clean. No content removed; just labels swapped
for words.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@M0LTE
M0LTE merged commit 18724e1 into master May 5, 2026
6 checks passed
@M0LTE
M0LTE deleted the docs/strip-plan-numbering branch May 5, 2026 20:00
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