Skip to content

docs: fix typos, grammar issues and standardise Wi-Fi spelling#2635

Open
sefinek wants to merge 3 commits into
meshcore-dev:devfrom
sefinek:docs/fix-typos-and-grammar
Open

docs: fix typos, grammar issues and standardise Wi-Fi spelling#2635
sefinek wants to merge 3 commits into
meshcore-dev:devfrom
sefinek:docs/fix-typos-and-grammar

Conversation

@sefinek
Copy link
Copy Markdown

@sefinek sefinek commented May 28, 2026

Changes to markdown files only, no code changes.

README.md

  • Remove double punctuation ., in description
  • principalsprinciples
  • probprobably
  • WiFiWi-Fi

CONTRIBUTING.md

  • PLeasePlease
  • Add missing > prefix to [!NOTE] block so it renders as a callout on GitHub

docs/faq.md

  • specific the first bytespecify the first byte
  • in anywayin any way
  • **A: ****A:**
  • change to CR tochange CR to
  • air wareairwaves
  • MeshcoreMeshCore
  • firmware up needfirmware you need
  • IOS or AndriodiOS or Android
  • WiFi / WIFIWi-Fi, with TOC anchor updated accordingly
  • wifi hotspotWi-Fi hotspot

docs/cli_commands.md

  • 1.12.+1.12+
  • probprobably

docs/companion_protocol.md

  • avoid displayavoid displaying

docs/payloads.md

  • ackowledgementacknowledgement
  • NeighorsNeighbors

docs/number_allocations.md

  • protcolprotocol

This PR also fixes tables that were not written correctly and improves their formatting.
{F82FBA66-BC41-4BA8-A42F-756F9397B98A}
{131BED31-51C2-4E46-ACEA-B273EFCB6F4C}
[...]

Copy link
Copy Markdown
Contributor

@LitBomb LitBomb left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! I reviewed readme and FAQ. These two are good to go.

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