Skip to content

Fix typos and formatting in documentation and comments#2671

Open
sefinek wants to merge 15 commits into
meshcore-dev:devfrom
sefinek:fix/typos-grammar-formatting
Open

Fix typos and formatting in documentation and comments#2671
sefinek wants to merge 15 commits into
meshcore-dev:devfrom
sefinek:fix/typos-grammar-formatting

Conversation

@sefinek
Copy link
Copy Markdown
Contributor

@sefinek sefinek commented Jun 2, 2026

[Follow-up to #2637, #2636, #2635]

This PR fixes typos, grammar, and formatting in documentation, comments, and helper text. It also fixes Markdown fragments that were rendered incorrectly in the documentation at https://docs.meshcore.io.

In several places, it also standardizes spelling where British and American English variants were mixed.

Most of the issues were in docs/faq.md. Example fixes:

  • https://github.com/meshcore-dev/MeshCore/wiki/Repeater-&-Room-Server-CLI-Referencehttps://docs.meshcore.io/cli_commands
  • githubGitHub
  • Seed XIAOSeeed XIAO
  • Plain URLs were not rendered as clickable links in many places.

The remaining changes are similar in nature: typo, spelling, and formatting fixes...

The PR also normalizes line endings in two JSON files. This does not change their values or configuration.

The introduced changes do not modify the firmware logic or behavior. They only affect documentation, comments, text, and formatting.

Tests

  1. Ran git diff --check.
  2. Checked documentation rendering on GitHub Pages: https://sefinek.github.io/MeshCore
  3. Checked the PR preview before changing its status from Draft to Ready for review.

Screenshots

Before (production) After (development)

@sefinek sefinek marked this pull request as ready for review June 2, 2026 22:45
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