Fix typos and formatting in documentation and comments#2671
Merged
liamcottle merged 15 commits intoJun 4, 2026
Conversation
LitBomb
approved these changes
Jun 4, 2026
Contributor
LitBomb
left a comment
There was a problem hiding this comment.
Thanks again for more updates to the FAQ to make it more readable and proper on both github and meshcore.io.
I reviewed the changes to FAQ and Readme. They continue to render properly on github. They are good to go.
BTW, I will be traveling in the next two months. I will be less active on discord and on github. Please excuse my lack of response.
Contributor
Author
|
@LitBomb Safe travels! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
[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-Reference→https://docs.meshcore.io/cli_commandsgithub→GitHubSeed XIAO→Seeed XIAOThe 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.
Verification
git diff --check.Screenshots