mirror of
https://github.com/Abdess/retroarch_system.git
synced 2026-11-05 09:33:52 -06:00
docs: write headings in sentence case
The gaps page and the Advanced usage, Verification modes, Release process and Testing guide pages titled in Title Case beside sentence-case pages. A test now reads every wiki heading.
This commit is contained in:
Abdessamad Derraz committed
1 parent
bb19a6d5cf
commit
23b69d185c
7 files changed
+73
-31
No files matched your search
@@ -1,8 +1,8 @@
|
||||
# Advanced Usage
|
||||
# Advanced usage
|
||||
|
||||
Fine-grained control over pack generation, hardware filtering, truth analysis, and verification.
|
||||
|
||||
## Custom Packs
|
||||
## Custom packs
|
||||
|
||||
### Build from hash
|
||||
|
||||
@@ -188,7 +188,7 @@ under the name the platform files the target by, whichever alias was typed:
|
||||
never overwrite the full one.
|
||||
|
||||
|
||||
## Pack Source Variants
|
||||
## Pack source variants
|
||||
|
||||
A pack is built from two file sources: the platform's own declared list
|
||||
(layer 1) and the requirements of the emulator profiles that apply to it
|
||||
@@ -223,7 +223,7 @@ visible.
|
||||
Variants compose with `--split`, `--target` and `--manifest`.
|
||||
|
||||
|
||||
## Hardware Target Filtering
|
||||
## Hardware target filtering
|
||||
|
||||
### What targets are
|
||||
|
||||
@@ -291,7 +291,7 @@ treat `--target <their-only-target>` as a no-op: the output is identical to runn
|
||||
without `--target`.
|
||||
|
||||
|
||||
## Truth Generation and Diffing
|
||||
## Truth generation and diffing
|
||||
|
||||
### What truth is
|
||||
|
||||
@@ -360,7 +360,7 @@ makes md5 and core required on every element, and RomM compares the file
|
||||
size before any hash, so an entry missing either could never verify.
|
||||
|
||||
|
||||
## Emulator-Level Verification
|
||||
## Emulator-level verification
|
||||
|
||||
### Per-emulator checks
|
||||
|
||||
@@ -410,7 +410,7 @@ emulator profiles. Files without ground truth rely solely on platform-level veri
|
||||
JSON output (`--json`) always includes the full per-emulator detail regardless of verbosity.
|
||||
|
||||
|
||||
## Offline Workflow
|
||||
## Offline workflow
|
||||
|
||||
### Full offline pipeline
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ Projects built on RetroBIOS data.
|
||||
|
||||
---
|
||||
|
||||
## BIOS Preservation Tool
|
||||
## BIOS preservation tool
|
||||
|
||||
**Author:** [monster-penguin](https://github.com/monster-penguin)
|
||||
**Repository:** [github.com/monster-penguin/BIOS-Preservation-Tool](https://github.com/monster-penguin/BIOS-Preservation-Tool)
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Release Process
|
||||
# Release process
|
||||
|
||||
This page documents the CI/CD pipeline: what each workflow does, how releases
|
||||
are built, and how to run the process manually.
|
||||
@@ -23,7 +23,7 @@ maintainer's machine and uploaded with `gh`, see
|
||||
[cutting a release](#cutting-a-release): the packs weigh 25 GB, more than a
|
||||
hosted runner should rebuild and re-upload.
|
||||
|
||||
## deploy-site.yml - Deploy Documentation Site
|
||||
## deploy-site.yml - Deploy documentation site
|
||||
|
||||
**Trigger.** Push to `main` when any of these paths change: `platforms/`,
|
||||
`emulators/`, `provenance/`, `wiki/`, `schemas/`, `tests/`, `docs_assets/`,
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Testing Guide
|
||||
# Testing guide
|
||||
|
||||
This page covers how to run, understand, and extend the test suite.
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
# Verification Modes
|
||||
# Verification modes
|
||||
|
||||
Each platform verifies BIOS files differently. `verify.py` replicates the native behavior
|
||||
of each platform so that verification results match what the platform itself would report.
|
||||
|
||||
|
||||
## Existence Mode
|
||||
## Existence mode
|
||||
|
||||
**Platforms**: RetroArch, Lakka, RetroPie
|
||||
|
||||
@@ -26,7 +26,7 @@ Lakka and RetroPie inherit this behavior through platform config inheritance
|
||||
(`inherits: retroarch` in the platform YAML).
|
||||
|
||||
|
||||
## MD5 Mode
|
||||
## MD5 mode
|
||||
|
||||
**Platforms**: Batocera, RetroBat, Recalbox, EmuDeck, RetroDECK, RomM, ROCKNIX, MiSTer FPGA
|
||||
|
||||
@@ -127,7 +127,7 @@ The 208 `games/` files shipped by the `Distribution_MiSTer` repository carry no
|
||||
URL and install themselves, so they are not part of the pack.
|
||||
|
||||
|
||||
## SHA1 Mode
|
||||
## SHA1 mode
|
||||
|
||||
**Platforms**: BizHawk
|
||||
|
||||
@@ -141,7 +141,7 @@ via `compute_hashes()` and compares case-insensitively.
|
||||
| File missing | MISSING | CRITICAL | WARNING |
|
||||
|
||||
|
||||
## Emulator-Level Validation
|
||||
## Emulator-level validation
|
||||
|
||||
Independent of platform verification mode, `verify.py` runs emulator-level validation
|
||||
from `validation.py`. This layer uses data from emulator profiles (YAML files in
|
||||
@@ -199,7 +199,7 @@ This catches cases where a file has the right name but wrong content, which exis
|
||||
platforms cannot detect.
|
||||
|
||||
|
||||
## Severity Matrix
|
||||
## Severity matrix
|
||||
|
||||
`compute_severity()` maps the combination of status, required flag, verification mode,
|
||||
and HLE fallback to a severity level.
|
||||
@@ -221,7 +221,7 @@ is still included in packs (better accuracy with the real BIOS), but its absence
|
||||
actionable.
|
||||
|
||||
|
||||
## File Resolution Chain
|
||||
## File resolution chain
|
||||
|
||||
Before verification, each file entry is resolved to a local path by `resolve_local_file()`.
|
||||
The function tries these steps in order, returning the first
|
||||
@@ -259,7 +259,7 @@ the divergence is printed as a discrepancy: an error in an upstream BIOS list
|
||||
must not remove a file the frontend would have loaded.
|
||||
|
||||
|
||||
## Discrepancy Detection
|
||||
## Discrepancy detection
|
||||
|
||||
When platform verification passes but emulator validation fails, the file has a discrepancy.
|
||||
This happens most often in existence-mode platforms where any file with the right name is
|
||||
|
||||
Reference in new issue
Block a user