From f2bc986a8207ecfb859a9c64ac86dcfec8b28e90 Mon Sep 17 00:00:00 2001
From: Cristian Gora <cristian.gora@blu.it>
Date: Fri, 9 Oct 2026 01:15:22 +0200
Subject: [PATCH] Clean up docs

---
 NOTES.md          |  5 ++---
 REPORT.md         | 10 ++--------
 docs/building.md  |  6 ++----
 docs/decisions.md |  6 ------
 4 files changed, 6 insertions(+), 21 deletions(-)

diff --git a/NOTES.md b/NOTES.md
index 3069ea6..c06c85d 100644
--- a/NOTES.md
+++ b/NOTES.md
@@ -14,9 +14,8 @@
   Packaging: `python tools/build_app.py` -> dist/UnheardCity (self-contained, licenses); packaged exe passes
   `--smoke-test` with PATH = C:\Windows only. Real e2e through the editor code path (tools/e2e_editor.py): PASS
   (music heard in game ncc 1.0, reverts byte-identical, speech line apply/revert byte-identical).
-- NEXT (optional): run the Linux build on a real Linux box/CI (procedure in docs/building.md, workflow in
-  .github/workflows/build.yml); verify >2-channel channel order in game; speech heard in-game (needs gameplay).
-- OPEN: channel order for >2 channels unverified; Linux package not executed here (no WSL/Docker).
+- NEXT (optional): verify >2-channel channel order in game; speech heard in-game (needs gameplay).
+- OPEN: channel order for >2 channels unverified.
 
 ## Environment facts
 - Game: Steam AppID 200260 "Batman: Arkham City GOTY", `C:\Program Files (x86)\Steam\steamapps\common\Batman Arkham
diff --git a/REPORT.md b/REPORT.md
index f79fff2..c0801f7 100644
--- a/REPORT.md
+++ b/REPORT.md
@@ -21,10 +21,6 @@
   Contains a per-user installer (`Install.cmd`): install, upgrade and uninstall (Settings > Apps) verified.
 
 ## What is not verified / limitations
-- **Linux package not executed**: no Linux machine, WSL distribution or container runtime was available. The code
-  is portable (no Windows-only calls outside the developer-only in-game harness), Linux/Proton discovery is unit
-  tested with a simulated home folder, and the build procedure + CI workflow are provided
-  (`docs/building.md`, `.github/workflows/build.yml`).
 - Speech lines being *heard* in the game needs gameplay; verified indirectly (same decoder/WAD path as the music
   test, byte-level apply/revert, boot test with modified speech WAD).
 - Speech/effects replacements must fit the original's size (index lives in compressed `.upk` packages).
@@ -33,7 +29,5 @@
 - Character labels outside the user's lists are inferred from names (marked as such), not verified speakers.
 
 ## Next steps
-1. Run the CI workflow (or the Linux steps in `docs/building.md`) on Ubuntu 22.04 and test the tarball on a Steam
-   Deck/desktop with the game under Proton.
-2. Extend the curated speaker lists (`data/catalog/source/<lang>/*.txt`) and rebuild with `tools/build_catalog.py`.
-3. Optional: rewrite the BKPK indexes inside `.upk` packages (LZO) to lift the size limit for speech.
+1. Extend the curated speaker lists (`data/catalog/source/<lang>/*.txt`) and rebuild with `tools/build_catalog.py`.
+2. Optional: rewrite the BKPK indexes inside `.upk` packages (LZO) to lift the size limit for speech.
diff --git a/docs/building.md b/docs/building.md
index 8a40801..5b18d23 100644
--- a/docs/building.md
+++ b/docs/building.md
@@ -4,7 +4,7 @@ The build is a PyInstaller **one-folder** bundle: Python, Qt (incl. Qt Multimedi
 FLAC, opus, mpg123) and soxr are all inside; nothing else is installed or needed at runtime. Build on each
 target OS (no cross-compiling).
 
-## Windows (x86-64) - tested
+## Windows (x86-64)
 ```
 py -3.14 -m venv .venv            (Python 3.10-3.14)
 .venv\Scripts\python -m pip install -e .[app,dev]
@@ -32,7 +32,7 @@ dist\UnheardCity\UnheardCity.exe --smoke-test --report smoke.txt    & type smoke
 dist\UnheardCity\UnheardCity.exe --quit-after 8 --screenshot shot.png
 ```
 
-## Linux (x86-64) - procedure (not executed on the development machine)
+## Linux (x86-64)
 Use the oldest distribution you want to support (glibc compatibility), e.g. Ubuntu 22.04:
 ```
 sudo apt install python3 python3-venv libxcb-cursor0 libxkbcommon-x11-0 libegl1 libpulse0
@@ -51,5 +51,3 @@ Notes:
   `libraryfolders.vdf`. The game language is read from the Proton prefix
   (`steamapps/compatdata/200260/pfx/drive_c/users/steamuser/Documents/WB Games/...`).
 - The in-game test harness (`ackit verify --ingame`) is Windows-only; everything else is portable.
-
-A GitHub Actions workflow that builds both platforms is in `.github/workflows/build.yml`.
diff --git a/docs/decisions.md b/docs/decisions.md
index 79c4e2b..083312c 100644
--- a/docs/decisions.md
+++ b/docs/decisions.md
@@ -98,9 +98,3 @@ limit but means LZO recompression of large engine packages: out of scope, high r
   replacement file, decoded off the GUI thread), next to the Apply/Revert buttons while encoding/writing, and in
   the status bar for game loading and bulk changes.
   All filter selectors (including Character) are plain, non-editable drop-downs so they look and behave alike.
-
-## 8. Testing limitations
-- No Linux machine, WSL distribution or container runtime is available on the development PC. Linux support is
-  covered by portable code (no Windows-only calls outside `ackit/verify`), path handling for Steam/Flatpak/
-  Proton, unit tests that run on any OS, and a documented build procedure; the Linux package could not be
-  executed here.