Abdessamad Derraz
1b9ea86e1b
scripts/sitediagrams.py writes the explainer, install flow, verification modes, MinUI card, pipeline and data layer diagrams as inline SVG from the registry, the platform files, the install manifests and the pipeline step list. A page asks for one with an image comment, which the decoration pass resolves. The two mermaid diagrams of the architecture page are replaced, so no page loads mermaid from unpkg. Platform logos and system icons are copied once by fetch_site_images.py with their source and owner recorded, and the build rewrites the remote links to the copies. validate_site refuses an image from another host. Three registry logos named a personal avatar instead of the project's (RomM, ROCKNIX, MiSTer FPGA) and MyMinUI's was a GitHub identicon, now dropped. One 1200x630 sharing card per section, a 404 page with search and the two entry pages, and a list of screenshots that need a real device.
2.9 KiB
Images that need a real device
These pictures show a real screen, so they are captured on a real install and
never drawn as a mock-up. Each entry says what the capture must show, where it
goes, and the alt text it carries. Folder layouts that follow from data are
drawn by scripts/sitediagrams.py instead (the MinUI card tree is
<!-- image: minui-card -->).
Captures: PNG or WebP, 1200 px wide at most, cropped tight, under 150 KB,
personal paths and user names removed. Menu labels are checked against the
current release of the software before the capture is used. Put each file in
docs_assets/screens/ and note the software version in the commit message.
RetroArch System/BIOS directory
Settings, Directory in RetroArch (Ozone menu), with the System/BIOS row highlighted and its path visible. For the RetroArch pages on Windows, macOS, Linux and Android.
Alt text: RetroArch Settings, Directory screen, with the System/BIOS line highlighted showing the folder path.
RetroArch firmware check
Main Menu, Information, Core Information after loading a PlayStation core, with the firmware lines reading Present. For RetroArch and Lakka pages, "Done when".
Alt text: RetroArch Core Information for a PlayStation core, each firmware line marked Present.
Steam Deck Desktop Mode and Konsole
Two panels: the Steam Deck power menu with Switch to Desktop selected, then the desktop with Konsole open and the install command pasted. For the EmuDeck and RetroDECK pages.
Alt text: Steam Deck power menu with Switch to Desktop selected, then the Konsole terminal open with the install command pasted.
Installer run, annotated
A real installer run in a terminal with three marks: the detected BIOS folder line, the confirmation prompt, and the Done line. For First install and every setup page.
Alt text: Installer output in a terminal, with marks on the detected folder, the install choice and the Done line.
Batocera network share from Windows
Windows File Explorer with \\BATOCERA\share\bios in the address bar and the
BIOS files listed. For the Batocera and KNULLI pages.
Alt text: Windows File Explorer showing the Batocera bios folder opened over the network.
Batocera missing BIOS screen
Batocera's main menu path to the missing BIOS check, and the result screen with no missing file for the consoles in use. For the Batocera page, "Done when".
Alt text: Batocera missing BIOS check listing no missing files.
Recalbox BIOS manager
Recalbox's BIOS checking screen with green, yellow and red entries visible. For the Recalbox page.
Alt text: Recalbox BIOS manager listing files marked present, present with another version, and missing.
A multi-part pack extracted
A file manager showing two downloaded parts and the single folder both were extracted into. For Get your files.
Alt text: Two downloaded pack parts and the one folder both were extracted into.