Skip to content

Standardize documentation nomenclature and improve editorial quality#1907

Closed
Amiga500 wants to merge 55 commits intoOnionUI:mainfrom
Amiga500:main
Closed

Standardize documentation nomenclature and improve editorial quality#1907
Amiga500 wants to merge 55 commits intoOnionUI:mainfrom
Amiga500:main

Conversation

@Amiga500
Copy link
Copy Markdown
Contributor

@Amiga500 Amiga500 commented Jan 30, 2026

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

Copilot AI and others added 8 commits January 30, 2026 03:39
…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
@helmasaur
Copy link
Copy Markdown

Why didn't you copy-paste the text? Could be useful, for example while searching through issues and PR.

Copilot AI and others added 21 commits January 30, 2026 15:28
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>
Copilot AI and others added 4 commits January 31, 2026 01:43
…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
@tGecko
Copy link
Copy Markdown
Member

tGecko commented Jan 31, 2026

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:

  • don't touch yarn.lock
  • don't touch versioned docs
  • don't touch blog posts, and release notes
  • remove the AI .md files (like BRANCH_WORK_SUMMARY.md)
  • OnionOS should always be simply "Onion", as that's the official name
  • Normalize to "MMP" where it is implied or repeated, and "Miyoo Mini Plus" where it is appropriate (like the website header)

Make sure to test and visibly inspect every site you change.

@tGecko tGecko self-assigned this Jan 31, 2026
Copilot AI and others added 19 commits January 31, 2026 12:38
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
@Amiga500
Copy link
Copy Markdown
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.

@Amiga500 Amiga500 closed this Jan 31, 2026
@Amiga500
Copy link
Copy Markdown
Contributor Author

Amiga500 commented Jan 31, 2026

image @Aemiii91 @tGecko I'm doing some tests with Copilot, on the left the official page, on the right the local one with some modifications. If no one on the team plans to work on it soon and you give me the OK, I can continue with this approach.

@tGecko
Copy link
Copy Markdown
Member

tGecko commented Feb 1, 2026

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

@Amiga500
Copy link
Copy Markdown
Contributor Author

Amiga500 commented Feb 1, 2026

That's fine!

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.

4 participants