Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
1df6a53
Initial plan
Copilot Jan 30, 2026
fe217a8
Fix nomenclature: Replace MMP/MM+/Mini+ with proper device names, Oni…
Copilot Jan 30, 2026
97a47cc
Fix nomenclature in versioned docs (v4.1, v4.2)
Copilot Jan 30, 2026
264177e
Fix punctuation, spacing, and RetroArch capitalization
Copilot Jan 30, 2026
d9ca00c
Fix remaining nomenclature issues in v4.2 docs
Copilot Jan 30, 2026
77cad39
Standardize Wi-Fi/WiFi capitalization and hyphenation
Copilot Jan 30, 2026
529fe2b
Merge pull request #13 from Amiga500/copilot/uniform-naming-conventions
Amiga500 Jan 30, 2026
f4c73d7
Update tagline for Miyoo Mini Plus
Amiga500 Jan 30, 2026
74b70ef
Initial plan
Copilot Jan 30, 2026
dddceeb
Add comprehensive list of MM occurrences in website section
Copilot Jan 30, 2026
d022f57
Add timestamp to MM occurrences document for clarity
Copilot Jan 30, 2026
05fe7db
Update MM occurrences list to include ALL subdirectories including ve…
Copilot Jan 30, 2026
42fc10d
Fix file count: 7 files with MM references (not 8)
Copilot Jan 30, 2026
4d168f8
Replace MM/MMP abbreviations with full device names throughout website
Copilot Jan 30, 2026
733539b
Fix spelling: utilisating -> utilizing
Copilot Jan 30, 2026
2c129a0
Merge pull request #14 from Amiga500/copilot/check-website-section-mm
Amiga500 Jan 30, 2026
4ce3b97
Initial plan
Copilot Jan 30, 2026
7adb237
Fix RetroArch capitalization and Wi-Fi standardization in docs
Copilot Jan 30, 2026
db1e788
Fix RetroArch and Wi-Fi in versioned docs, fix spelling errors
Copilot Jan 30, 2026
7ce79dd
Fix remaining RetroArch issues and Miyoo Mini+ references
Copilot Jan 30, 2026
62322df
Fix grammar issues from code review feedback
Copilot Jan 30, 2026
91840d3
Add comprehensive link verification report
Copilot Jan 30, 2026
6d74180
Add comprehensive branch work summary for 16 commits
Copilot Jan 30, 2026
9e05e10
Merge pull request #15 from Amiga500/copilot/update-website-text-corr…
Amiga500 Jan 30, 2026
4faf0e2
Initial plan
Copilot Jan 30, 2026
f99f081
Add comprehensive summary of all repository changes
Copilot Jan 30, 2026
e5f3a73
Fix punctuation spacing: remove spaces before colons and commas
Copilot Jan 31, 2026
b13fc88
Fix additional punctuation spacing issues in versioned docs
Copilot Jan 31, 2026
77cca1b
Fix documentation proofreading issues: spelling, grammar, and name co…
Copilot Jan 31, 2026
3435298
Add comprehensive proofreading summary documentation
Copilot Jan 31, 2026
f0108f9
Fix app name consistency: GameSwitcher and Ports Collection
Copilot Jan 31, 2026
6d5dac9
Standardize formatting: GitHub capitalization and users/devs spacing
Copilot Jan 31, 2026
1dc6dda
Standardize slash spacing: remove spaces in compound terms and produc…
Copilot Jan 31, 2026
cd49cef
Fix emulator name consistency: standardize DraStic capitalization
Copilot Jan 31, 2026
3082e7c
Fix malformed URL in DraStic repository link
Copilot Jan 31, 2026
b88af5d
Merge pull request #16 from Amiga500/copilot/summarize-all-changes
Amiga500 Jan 31, 2026
58fd72e
Initial plan
Copilot Jan 31, 2026
5a38721
Revert yarn.lock to original format with quoted keys
Copilot Jan 31, 2026
aa7bc34
Revert versioned docs to original state before PRs #13-16
Copilot Jan 31, 2026
fb1e54e
Revert blog posts and release notes to original state before PRs #13-16
Copilot Jan 31, 2026
2da1935
Remove AI-generated markdown files and add to .gitignore
Copilot Jan 31, 2026
7eb9937
Standardize naming to "Onion" (replace OnionOS and Onion OS)
Copilot Jan 31, 2026
5db1de9
Normalize device naming to MMP abbreviation where appropriate
Copilot Jan 31, 2026
5ac3842
Add abbreviation legend (MM/MMP) to introduction page
Copilot Jan 31, 2026
1545361
Merge pull request #17 from Amiga500/copilot/revert-yarn-lock-changes
Amiga500 Jan 31, 2026
c9e11c3
Initial plan
Copilot Jan 31, 2026
a05e343
Revert MM and MMP to abbreviations in shortcuts.md
Copilot Jan 31, 2026
5e3cb96
Merge pull request #18 from Amiga500/copilot/revert-changes-on-shortc…
Amiga500 Jan 31, 2026
489af2a
Initial plan
Copilot Jan 31, 2026
f768de9
Revert MMP/MM abbreviations to full device names in documentation
Copilot Jan 31, 2026
689ee58
Replace device abbreviations with full names in documentation
Copilot Jan 31, 2026
fdfaae2
Merge pull request #19 from Amiga500/copilot/revert-modifications-to-mmp
Amiga500 Jan 31, 2026
99f5543
Initial plan
Copilot Jan 31, 2026
a9848dd
Move abbreviations section before OS description in introduction
Copilot Jan 31, 2026
13697d5
Merge pull request #20 from Amiga500/copilot/update-documentation-int…
Amiga500 Jan 31, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,13 @@ static/dist/miyoo354/app/MainUI text eol=lf
static/build/.tmp_update/bin/shutdown text eol=lf
static/configs/.tmp_update/config/passwd text eol=lf
static/configs/.tmp_update/config/group text eol=lf

# Prevent yarn.lock from being automatically reformatted
website/yarn.lock linguist-generated=true

# Prevent versioned docs from being modified (historical documentation)
website/versioned_docs/** linguist-generated=true
website/versioned_sidebars/** linguist-generated=true

# Prevent blog posts and release notes from being modified (historical content)
website/blog/** linguist-generated=true
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,10 @@ src/sendUDP/sendUDP
src/tree/tree
src/pippi/pippi
src/cpuclock/cpuclock

# AI-generated documentation files (should not be committed)
BRANCH_WORK_SUMMARY.md
CHANGES_SUMMARY.md
LINK_VERIFICATION_REPORT.md
**/MM_OCCURRENCES.md
**/PROOFREADING_SUMMARY.md
20 changes: 10 additions & 10 deletions website/docs/01-features/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ The **Search** application is the perfect companion for large game collections.

:::note <a href="apps/theme-switcher">Theme-switcher overview</a>
Onion loves themes. Onion **Themes** allows you to customize the background, the entry categories, console icons, music background, fonts... And best of all, the chosen theme impacts all Onion's internal applications!<br />
**Themes** in Onion are two things : <br />
**Themes** in Onion are two things: <br />
- [A fabulous theme repository](https://github.com/OnionUI/Themes/blob/main/README.md) with a very active participation from Onion community <sup><sub>❤️</sub></sup>
- An application called <a href="apps/theme-switcher">Theme-switcher</a> included in Onion which allows to preview and change themes.
:::
Expand All @@ -110,7 +110,7 @@ Onion loves themes. Onion **Themes** allows you to customize the background, the
<p align="center"><img src={require('./assets/activity-tracker.webp').default} style={{width: 320}} /></p>

:::note <a href="apps/activity-tracker">Activity Tracker overview</a>
Thanks to **Activity Tracker** app you can :
Thanks to **Activity Tracker** app you can:
- Track your game playtimes.
- View your total playtime in the top bar.
- Share your playtimes by taking a screenshot (press <kbd>MENU</kbd>+<kbd>POWER</kbd> - screenshot is saved in `Screenshots` folder).
Expand All @@ -136,7 +136,7 @@ It allows you to change the color temperature of the screen to have more eye com


:::note <a href="apps/retroarch">RetroArch overview</a>
A full **RetroArch** in a such tiny device! **RetroArch** is regularly updated from the official repository. Onion benefits from dedicated drivers created by [Eggs](https://discordapp.com/users/778867980096241715) for precision and performance.
A full **RetroArch** in such a tiny device! **RetroArch** is regularly updated from the official repository. Onion benefits from dedicated drivers created by [Eggs](https://discordapp.com/users/778867980096241715) for precision and performance.
Dedicated customizations are also included: All the cores are configured with attention to detail, [custom overlays and custom filters](apps/retroarch#customized-overlays-and-filters) made specially for the Miyoo Mini screen.
:::

Expand All @@ -160,7 +160,7 @@ Onion has its own emulators, many optimizations on the **RetroArch** cores but a
<img src="https://user-images.githubusercontent.com/44569252/226447388-8c9c95f1-536a-4946-8b0f-f4b8ead0e97e.png" width="320" />

:::note <a href="apps/game-list-options">Game List Options overview</a>
**Game List Options** (GLO Menu) is a tool to make actions for the selected game or the entire list. Press <kbd>Y</kbd> in a game list then from this menu you can choose the **RetroArch** core, download the image cover of your game (WiFi/MMP required), launch a Netplay session, reset your game (to skip the last save state), filter the list of games with a keyword,...<br />Thanks to GLO Menu's flexibility, you can even add your own scripts here!*
**Game List Options** (GLO Menu) is a tool to make actions for the selected game or the entire list. Press <kbd>Y</kbd> in a game list, then from this menu you can choose the **RetroArch** core, download the image cover of your game (Wi-Fi/Miyoo Mini Plus required), launch a Netplay session, reset your game (to skip the last save state), filter the list of games with a keyword, and more.<br />Thanks to GLO Menu's flexibility, you can even add your own scripts here!*
:::


Expand Down Expand Up @@ -215,13 +215,13 @@ Check the <a href="included-apps">included apps</a> documentation for more infor
<img title="Included apps" src={require('./assets/network-features.gif').default} style={{width: 320}} />

:::note <a href="network-features">Network Features</a>
For the Miyoo Mini Plus (equipped with wifi) Onion offers many additional possibilities :<br />
For the Miyoo Mini Plus (equipped with Wi-Fi) Onion offers many additional possibilities:<br />
- [Multiplayer/Netplay](multiplayer): play in multiplayer over internet or on your local network to your favorite retro games:
- [Easy Netplay](multiplayer/easynetplay): play multiplayer games anywhere (compatible with GB/GBC Pokemon trading!)
- [OTA (Over The Air) updates](apps/ota-update): update Onion directly from your MMP
- [OTA (Over The Air) updates](apps/ota-update): update Onion directly from your Miyoo Mini Plus
- [Automatic date/time synchronisation](apps/tweaks#set-automatically-via-the-internet) (NTP, via Tweaks app)
- [Retroachivements](https://www.retroarch.com/?page=achievements)
- [Scraper](/docs/apps/scraper): import game covers directly from your MMP
- [RetroAchievements](https://www.retroarch.com/?page=achievements)
- [Scraper](/docs/apps/scraper): import game covers directly from your Miyoo Mini Plus
- [Network Services](network-features): [Samba/SMB share](network/samba), [http server](network/http), [SSH](network/ssh), [FTP](network/ftp), [Telnet](network/telnet), [Hotspot](network/hotspot), [VNC server](network/vnc)...
:::

Expand All @@ -240,15 +240,15 @@ Simply copy this folder when you want to backup your data.
## <sup><img align="left" src="https://user-images.githubusercontent.com/44569252/179305495-2ae1f522-6918-469f-a2eb-63dd30262e17.png" width="54" /></sup>MainUI improvements

:::note MainUI improvements
MainUI is the main interface of Onion provided by Miyoo and modified by Onion Team with these improvements :
MainUI is the main interface of Onion provided by Miyoo and modified by Onion Team with these improvements:

- Battery percentage is shown in the top bar
> You can configure the battery percentage visibility and color in the theme configuration file. It is also possible to make a theme that only shows the percentage text.
- No more audio lag
<sup>Credit: Eggs</sup>
- New default theme inspired by the Lilla theme by Evolve
<sup>Credit: DiMo</sup>
- OnionOS icon by Evolve
- Onion icon by Evolve
- Textures are compressed for faster results
<sup>Credit: DiMo</sup>
- Box art size fix in the included themes
Expand Down
6 changes: 3 additions & 3 deletions website/docs/02-installation/01-fresh-install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ If your SD card is larger than 32 GB, you need to use a third-party tool like [R
5. **Cluster size** at `32 kilobytes` should be fine (`16 kilobytes` might extend the life of your SD card)
6. Click **START** to format the card, when it's done you can close the window

:::info GUIFormat / fat32format
We do not recommend using *GUIFormat / fat32format*, since many users are reporting file system errors on cards above 128 GB
:::info GUIFormat/fat32format
We do not recommend using *GUIFormat/fat32format*, since many users are reporting file system errors on cards above 128 GB
:::

</TabItem>
Expand Down Expand Up @@ -122,7 +122,7 @@ Themes/
3. Insert the SD card into the Miyoo device, and turn it on to begin the installation.
4. When the installation is done, you'll be prompted with the **Quick Guide** - *a quick overview of Onion*
5. Then you'll be presented with the **Package Manager**, choose the systems and apps you want enabled, then press <kbd>START</kbd> twice
6. When the installation is done, press the <kbd>A</kbd> button and the device will turn off (MM) or reboot (MMP).
6. When the installation is done, press the <kbd>A</kbd> button and the device will turn off (Miyoo Mini) or reboot (Miyoo Mini Plus).


## Step 3: Copy over your ROM and BIOS files
Expand Down
10 changes: 5 additions & 5 deletions website/docs/02-installation/02-upgrading.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ import TabItem from '@theme/TabItem';
*When upgrading, your save states, in-game saves, roms, bios files, and
configs will carry over to the updated system.*

:::note OTA UPDATES (MMP)
The Miyoo Mini+ (Plus) can update Onion via the Wi-Fi connection using the OTA Update app. If the OTA update fails, simply follow the steps below to perform a manual update.
:::note OTA UPDATES (Miyoo Mini Plus)
The Miyoo Mini Plus can update Onion via the Wi-Fi connection using the OTA Update app. If the OTA update fails, simply follow the steps below to perform a manual update.
:::


Expand Down Expand Up @@ -61,13 +61,13 @@ please **make sure to create in-game saves** before upgrading.
<TabItem value="chromeos" label="Chrome OS">

:::tip Recommended method
Due to limitations in the way the Chrome OS File Manager works, it's recommended to backup your personal files, perform a clean install of Onion OS on the SD card, and then restore your backed up files. The following instructions go through this procedure.
Due to limitations in the way the Chrome OS File Manager works, it's recommended to backup your personal files, perform a clean install of Onion on the SD card, and then restore your backed up files. The following instructions go through this procedure.
:::

1. Display the contents of the SD card on the File Manager by double-clicking the drive icon.
2. Backup your personal files such as the ones under `Roms`, `BIOS`, `Saves` and `Themes` directories.
3. Perform a [clean install](/docs/installation/fresh) on the SD card.
4. Restore your files on the newly installed Onion SD card. **Do not move a file to the same location as one with the same name**. This will cause the moved file to be duplicated with a number appended to it, and won't be recognized by Onion OS.
4. Restore your files on the newly installed Onion SD card. **Do not move a file to the same location as one with the same name**. This will cause the moved file to be duplicated with a number appended to it, and won't be recognized by Onion.

</TabItem>
</Tabs>
Expand All @@ -81,7 +81,7 @@ If you're upgrading from v3.9 or below, we recommend you delete the `.tmp_update

1. The installation will begin when you boot up your Miyoo Mini.

2. When the installation is done, press the <kbd>A</kbd> button and the device will turn off (MM) or reboot (MMP).
2. When the installation is done, press the <kbd>A</kbd> button and the device will turn off (Miyoo Mini) or reboot (Miyoo Mini Plus).


## Step 3: Check that your files are in the correct folders
Expand Down
16 changes: 8 additions & 8 deletions website/docs/02-installation/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Take a look at the [*firmware upgrade guide*](https://user-images.githubusercont
2. Select your device in the tabs below, then check that you have the appropriate firmware version.

<Tabs groupId="device" queryString>
<TabItem value="mm" label="Miyoo Mini (MM)">
<TabItem value="mm" label="Miyoo Mini">


:::info 'The Boya Incident'
Expand All @@ -53,11 +53,11 @@ Please apply the community patch found below. [Read more](https://docs.google.co
- `2022 12 24 0121` ⚠️
- `2023 01 04 1337` ✔️ (community patch)
- `2023 06 11 1426` ✔️
- `2023 10 27 1401` ✔️ (**only for MM v4**)
- `2023 10 27 1401` ✔️ (**only for Miyoo Mini v4**)

Firmware `2023 10 27 1401` and newer in conjunction with Onion 4.3 allow the MM v4 to run games at 752x560.
Firmware `2023 10 27 1401` and newer in conjunction with Onion 4.3 allow the Miyoo Mini v4 to run games at 752x560.

:::note Firmware downloads (MM)
:::note Firmware downloads (Miyoo Mini)

<IconLink href="https://drive.google.com/drive/folders/1VtfcBCoIcpMIBY2FIyAtjV-Dg02JUvhG" icon="cloud_download">Firmware 20220419</IconLink><br/>

Expand All @@ -66,7 +66,7 @@ Firmware `2023 10 27 1401` and newer in conjunction with Onion 4.3 allow the MM
:::

</TabItem>
<TabItem value="mmp" label="Miyoo Mini+ (MMP)">
<TabItem value="mmp" label="Miyoo Mini Plus">


3. You need at least firmware version `20230505****`, if you have an older version please download the recommended firmware linked below.
Expand All @@ -80,7 +80,7 @@ Firmware `2023 10 27 1401` and newer in conjunction with Onion 4.3 allow the MM
- `2023 06 09 2122` ✔️
- `2023 06 28 2128` ✔️

:::note Firmware downloads (MMP)
:::note Firmware downloads (Miyoo Mini Plus)

<IconLink href="https://drive.google.com/drive/folders/1zPk9t10AiRsjYKjIRrg8XbPUh0Nm2ej0" icon="cloud_download">Firmware 20230628</IconLink>

Expand All @@ -92,8 +92,8 @@ Firmware `2023 10 27 1401` and newer in conjunction with Onion 4.3 allow the MM

## <sup><img align="left" src="https://user-images.githubusercontent.com/44569252/179302769-4169e57a-860f-4c0e-8792-007e7557ba48.png" width="54" /></sup> Download the installation files

:::info MMP support
You need to install **Onion V4.2** for MMP, as earlier versions doesn't support the new hardware.
:::info Miyoo Mini Plus Support
You need to install **Onion V4.2** for the Miyoo Mini Plus, as earlier versions don't support the new hardware.
:::

Download the latest version of Onion:
Expand Down
Loading