Standardize documentation nomenclature and improve editorial quality#1907
Closed
Amiga500 wants to merge 55 commits intoOnionUI:mainfrom
Closed
Standardize documentation nomenclature and improve editorial quality#1907Amiga500 wants to merge 55 commits intoOnionUI:mainfrom
Amiga500 wants to merge 55 commits intoOnionUI:mainfrom
Conversation
…onOS capitalization Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Standardize documentation nomenclature and improve editorial quality
|
Why didn't you copy-paste the text? Could be useful, for example while searching through issues and PR. |
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
…rsioned_docs Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Replace device abbreviations with full names in website documentation
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
…ections Standardize documentation nomenclature and verify link integrity
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
…nsistency Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
…t names Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Standardize DraStic emulator capitalization
Member
|
Hi there, thanks for your contribution. Most of them are perfect, but you'll need to change some of them so we can accept it:
Make sure to test and visibly inspect every site you change. |
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Add MM/MMP abbreviation legend to documentation
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
…uts-md Normalize device names to abbreviations in shortcuts documentation
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
Replace device abbreviations with full names in documentation
Co-authored-by: Amiga500 <16525337+Amiga500@users.noreply.github.com>
…roduction Move abbreviations section before OS description in introduction
Contributor
Author
|
Hi @tGecko, thanks for your suggestions, i will keep that in mind, i'll prefer to close this PR and work from scratch locally. |
Contributor
Author
Member
|
I think we should keep the human written text. The right one instantly feels like AI wrote it. It's a bit too much imo |
Contributor
Author
|
That's fine! |
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.

Phase 1: Nomenclature Fixes ✅
Standardize device references to "Miyoo Mini" (base model) and "Miyoo Mini Plus" (Plus model)
Replace abbreviations "MMP", "MM+", "Mini+" with "Miyoo Mini Plus" in prose contexts as same for Miyoo Mini.
Fix "Onion OS" → "OnionOS" (all instances corrected)
Update versioned documentation (v4.1 and v4.2) with same fixes
Fix "RetroArch" capitalization throughout all documents (was "Retroarch", "retroarch")
Standardize Wi-Fi/WiFi usage (Wi-Fi for prose, WiFi for technical/label contexts)
Phase 2: Punctuation and Formatting ✅
Fix spacing around punctuation marks (commas, colons, semicolons)
Remove spaces before commas
Add proper spacing after commas
Fix colons with proper spacing (e.g., "like :" → "like:")
Add Oxford commas where appropriate
Improve sentence structure and flow
Phase 3: Grammar and Style Review ✅
Improve sentence fluidity (e.g., "However, its integration...")
Fix grammatical errors (e.g., "such a tiny device", "official" not "offcial", "Many" not "Meny")
Fix spelling errors (e.g., "equipped" not "equiped", "possibilities" not "possibilites")
Maintain professional yet accessible tone throughout
Add commas for better readability in complex sentences
Summary of Changes ✅
48 files modified across docs, blog posts, and versioned documentation
120+ lines changed with improved consistency and professionalism
All instances of incorrect nomenclature corrected
Punctuation standardized across all documentation
Grammar and style improved for better readability
Wi-Fi/WiFi usage now consistent (Wi-Fi in prose, WiFi in technical contexts)
Files Updated ✅
Core documentation (docs/)
Blog/release notes (blog/)
Versioned docs v4.1 and v4.2 (versioned_docs/)
Installation guides, FAQ, app documentation, network features, emulator guides, multiplayer documentation, and community apps