Skip to content

docs: update to align with current implementation#1823

Open
robekl wants to merge 3 commits intomeshcore-dev:mainfrom
robekl:docs_update_main
Open

docs: update to align with current implementation#1823
robekl wants to merge 3 commits intomeshcore-dev:mainfrom
robekl:docs_update_main

Conversation

@robekl
Copy link

@robekl robekl commented Feb 24, 2026

Summary

Documentation-only PR to align main docs with current dev behavior and protocol details.

High-Level Changes by Category

Companion Behavior & Routing

  • Updated docs to reflect that companion nodes do not repeat by default.
  • Added/clarified optional companion client repeat mode and its constraints.

CLI Documentation

  • Added missing commands and corrected command details/defaults.
  • Fixed outdated command descriptions and minor terminology issues.

Companion Protocol

  • Updated protocol version references.
  • Corrected frame formats, field sizes, packet meanings, and units.
  • Added missing details for repeat-mode-related protocol fields.

Payload & Packet Specs

  • Corrected payload field semantics and tag/ack descriptions.
  • Replaced stale version-specific wording with current implementation behavior.
  • Filled incomplete payload sections with implementation-aligned definitions.

FAQ Accuracy

  • Updated answers that were out of date with current implementation.
  • Corrected OTA/WiFi setup references and minor wording/grammar issues.

Copy link
Member

@liamcottle liamcottle left a comment

Choose a reason for hiding this comment

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

Other than the couple of comments I added, everything else looks pretty good thanks :)

@robekl robekl requested a review from liamcottle February 26, 2026 14:16
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.

2 participants