Skip to content

docs: clarify release verification and terms - #11

Merged
gautamgpt1 merged 2 commits into
MeshLive:mainfrom
Aaqibhafeezkhan:docs/issue-4-install-guide
Oct 22, 2026
Merged

gautamgpt1 merged 2 commits into
MeshLive:mainfrom
Aaqibhafeezkhan:docs/issue-4-install-guide

Conversation

@Aaqibhafeezkhan

Copy link
Copy Markdown
Contributor

Summary

Improves the user guide with clearer release-verification instructions and definitions for key MeshLive terminology.

Changes

  • Clarifies that release verification commands are run on a computer, not on the Android device.
  • Explains which release files to download together: the APK, SHA256SUMS, and SOURCE-MANIFEST.txt.
  • Identifies the tools needed for verification: apksigner, sha256sum, and GitHub CLI.
  • Clarifies that skipping a verification step should not be treated as a successful check.
  • Adds concise definitions for GATT, CoC, relay, hop, and attestation.

#4

@gautamgpt1
gautamgpt1 self-requested a review October 22, 2026 18:19

@gautamgpt1 gautamgpt1 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks a lot, this is clear and accurate, and the "skipping a check is not a pass" line is exactly right. One small fix: CoC stands for L2CAP connection-oriented channel (credit-based flow control is the mode it uses). I've added a suggestion below; once applied I'll merge it.

Comment thread docs/user-guide.md Outdated
## Glossary

- **GATT (Generic Attribute Profile):** Bluetooth Low Energy communication used by MeshLive by default. It works without pairing on most phones, but has lower throughput than Bluetooth Classic.
- **CoC (Credit-Based Flow Control):** Bluetooth Low Energy L2CAP connection-oriented channels, an experimental transport in MeshLive. Support varies across phone Bluetooth stacks.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

  • CoC (L2CAP connection-oriented channel): a direct Bluetooth Low Energy data channel, an experimental transport in MeshLive. Support varies across
    phone Bluetooth stacks.

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