From 43fe0fff0f29108b7448b692d131c45f7f086b92 Mon Sep 17 00:00:00 2001 From: Abdessamad Derraz <3028866+Abdess@users.noreply.github.com> Date: Fri, 23 Oct 2026 18:54:01 +0200 Subject: [PATCH] docs: fit start pages to their word ceilings --- tests/test_site_copy.py | 4 ++-- tests/test_site_r4_wiki.py | 4 ++-- wiki/faq.md | 18 ++++++++---------- wiki/troubleshooting.md | 22 +++++++--------------- 4 files changed, 19 insertions(+), 29 deletions(-) diff --git a/tests/test_site_copy.py b/tests/test_site_copy.py index 3f7dff44..ebf80951 100644 --- a/tests/test_site_copy.py +++ b/tests/test_site_copy.py @@ -32,8 +32,8 @@ START_PAGES = { "which-pack.md": 400, "wiki/what-are-bios-files.md": 300, "wiki/first-install.md": 400, - "wiki/troubleshooting.md": 345, - "wiki/faq.md": 480, + "wiki/troubleshooting.md": 300, + "wiki/faq.md": 450, "wiki/glossary.md": 200, } # Level 1: the guide part of each setup page, above its Reference heading. diff --git a/tests/test_site_r4_wiki.py b/tests/test_site_r4_wiki.py index 78811b7e..3599849e 100644 --- a/tests/test_site_r4_wiki.py +++ b/tests/test_site_r4_wiki.py @@ -85,7 +85,6 @@ class TroubleshootingSaysTheWordsOnScreen(unittest.TestCase): section = _flat(_section(self.text, "The BIOS is fine, the game still fails")) self.assertIn('"Please insert PlayStation CD-ROM"?** The BIOS works.', section) self.assertIn("open its `.cue` or `.m3u` file, not a `.bin`", section) - self.assertIn("swanstation README.md:36", section) def test_terms_for_search(self): terms = _front(self.text)["terms"] @@ -192,7 +191,8 @@ class FaqLabels(unittest.TestCase): def test_no_reference_label(self): self.assertNotRegex(self.text, r"(?m)^Reference:") arcade = _section(self.text, "My arcade game fails (which MAME version?)") - self.assertIn(f"Which version each emulator reads: [the list]({ARCADE_ANCHOR}).", arcade) + self.assertIn(f"Game sets must match the emulator's version:\n[the list]({ARCADE_ANCHOR}).", + arcade) def test_the_card_sentence(self): self.assertIn("For RetroArch on a Switch,\nwith the card in drive `E:`, run:", self.text) diff --git a/wiki/faq.md b/wiki/faq.md index 0c880f99..9c7254d9 100644 --- a/wiki/faq.md +++ b/wiki/faq.md @@ -38,12 +38,12 @@ the ZIPs inside zipped, like `neogeo.zip`. ## Does a BIOS work on every setup? -Usually. The command installs each setup's own version, like its `neogeo.zip`. +Usually. The command installs each setup's own, like its `neogeo.zip`. ## My arcade game fails (which MAME version?) { #my-arcade-game-does-not-start } -The game set must match the emulator's version, and `neogeo.zip` stays zipped. -Which version each emulator reads: [the list](technical-faq.md#which-mame-version-do-the-arcade-bios-sets-match). +Game sets must match the emulator's version: +[the list](technical-faq.md#which-mame-version-do-the-arcade-bios-sets-match). ## Keys, firmware or BIOS? @@ -58,8 +58,7 @@ Sometimes, with an emulator's stand-in, but some games fail. ## Is the command safe? { #is-piping-the-installer-into-a-shell-safe } -- It stops if the installer does not match its expected fingerprint, and checks - each file. +- It checks the installer and each file against their fingerprints. - It writes in your BIOS folder, and for some emulators your save folder. - It never touches a game or a save. - It keeps each file it replaces in `retrobios-backup`. `--restore` puts it @@ -80,7 +79,7 @@ setup's files and checks each one. `--dry-run` shows the list first. ## Fill an SD card from a computer? -Yes. Name your setup and the card's BIOS folder. For RetroArch on a Switch, +Name your setup and the card's BIOS folder. For RetroArch on a Switch, with the card in drive `E:`, run: @@ -97,7 +96,7 @@ Fill its folder from a computer, as above, or unzip your ZIP and check it with ## My setup is not in the list - Name your emulator's BIOS folder with `--dest`. -- ES-DE, LaunchBox: the command fills the folders of the emulators they start. +- ES-DE, LaunchBox: the command fills their emulators' folders. - iPhone, iPad (iOS): no terminal. Use the ZIP. ## Why is a file missing from the ZIP? @@ -110,9 +109,8 @@ Often a missing BIOS: [When a game does not start](troubleshooting.md). ## Can I copy my own console's BIOS? { #copy-your-own-bios } -Yes. The emulators explain how: [PCSX2](https://pcsx2.net/docs/setup/bios/) -for PlayStation 2, [melonDS](https://melonds.kuribo64.net/faq.php) for DS and -DSi. +Yes: [PCSX2](https://pcsx2.net/docs/setup/bios/) for PlayStation 2, +[melonDS](https://melonds.kuribo64.net/faq.php) for DS and DSi. ## Is this legal? diff --git a/wiki/troubleshooting.md b/wiki/troubleshooting.md index bba8e39d..2be073a2 100644 --- a/wiki/troubleshooting.md +++ b/wiki/troubleshooting.md @@ -43,14 +43,11 @@ Run it without `--check`. It adds missing files and replaces wrong ones. ## 3. Check the folder and the names - **Right folder?** [Get your files](../which-pack.md) names it. -- **Exact name?** `scph5501.bin` and `SCPH-5501.BIN` differ. On Linux, - capitals count too. The command adds names that differ by capitals. +- **Exact name?** `scph5501.bin` and `SCPH-5501.BIN` differ. - **A `bios` folder inside your BIOS folder?** Move its files up one level. - **BIOS setting on a subfolder, like `system/dc`?** Point it at the BIOS - folder itself. Some emulators add their own, like `dc/` for Flycast, and - the command puts the files there. -- **A ZIP in parts, like `Pack.part1of2.zip`?** Unzip every part into one - folder. + folder. Emulators add their own, like `dc/` for Flycast. +- **A ZIP in parts?** Unzip every part into one folder. @@ -60,10 +57,9 @@ shell/libretro/libretro.cpp:2252-2253, emulators/flycast.yml. --> It needs its BIOS set, like `neogeo.zip`, and a game set for the same emulator version. -- Keep `neogeo.zip` zipped. -- A game set for another MAME version often fails. +- Another MAME version's game set often fails. Details: [the version of each emulator](technical-faq.md#which-mame-version-do-the-arcade-bios-sets-match). -- Run the command once. It installs the BIOS sets your emulators read. +- Run the command once. It installs the BIOS sets. ## The BIOS is fine, the game still fails @@ -71,17 +67,13 @@ version. - **A BIOS setting?** Some emulators can skip the BIOS. In PCSX ReARMed, set **BIOS Selection** to **Auto**. - **The screen says "Please insert PlayStation CD-ROM"?** The BIOS works. - The game did not load: open its `.cue` or `.m3u` file, not a `.bin`. A - disc from another region shows it too. - - + The game did not load: open its `.cue` or `.m3u` file, not a `.bin`. ## If the command fails { #installation-script-fails } - **Network error:** try again later. - **`The clock reads ...`:** set the right date. -- **Permission denied:** do what the message says. It names what to run. +- **Permission denied:** do what the message says. - **No setup found:** name it and its folder: