docs(reference): adopt the last reference files from the project root #46

fabi · 2026-09-16T20:21:20Z

fabi commented

2026-09-16 20:21:20 +00:00

The project root still held three reference files that exist in no repository. This adopts them, so the root copies can be deleted.

root file	→	change
`compass_artifact_wf-…_text_markdown.md` (44 KB)	`docs/reference/xbox360-re-technical-reference.md`	unchanged, plus a provenance note
`docs/XBOX360_ARCHITECTURE.md`	`docs/reference/xbox360-architecture.md`	trimmed to the platform facts
`generate_export_docs.py`	`tools/generate_export_docs.py`	takes `--canary` / `--out`

Why the quick reference was trimmed. It was written before any of Sylpheed's formats were decoded. Its "status" sections said the PAK and mesh formats were unknown and audio was a TODO, and it described a just sniff workflow that no longer exists. docs/reference/ holds reference material, not project status, so those parts are dropped and the page points at docs/re/INDEX.md instead.

The export generator. The committed xbox360-exports.{md,json} already name tools/generate_export_docs.py as their generator, so the script goes to that path. It used to run inside a Canary checkout. It now reads one via --canary (default ../xenia-canary) and fails loudly on a tree that isn't Canary.

Checked: a run against the local Canary tree reproduces the format, with an identical header and 2,913 exports. Only 8 rows differ from the committed copy, all implementation statuses that changed in Canary since. Pointing it at a non-Canary directory exits with an error.

No Rust changes.

🤖 Generated with Claude Code

The project root still held three reference files that exist in no repository. This adopts them, so the root copies can be deleted. | root file | → | change | |---|---|---| | `compass_artifact_wf-…_text_markdown.md` (44 KB) | `docs/reference/xbox360-re-technical-reference.md` | unchanged, plus a provenance note | | `docs/XBOX360_ARCHITECTURE.md` | `docs/reference/xbox360-architecture.md` | trimmed to the platform facts | | `generate_export_docs.py` | `tools/generate_export_docs.py` | takes `--canary` / `--out` | **Why the quick reference was trimmed.** It was written before any of Sylpheed's formats were decoded. Its "status" sections said the PAK and mesh formats were unknown and audio was a TODO, and it described a `just sniff` workflow that no longer exists. `docs/reference/` holds reference material, not project status, so those parts are dropped and the page points at `docs/re/INDEX.md` instead. **The export generator.** The committed `xbox360-exports.{md,json}` already name `tools/generate_export_docs.py` as their generator, so the script goes to that path. It used to run inside a Canary checkout. It now reads one via `--canary` (default `../xenia-canary`) and fails loudly on a tree that isn't Canary. **Checked:** a run against the local Canary tree reproduces the format, with an identical header and 2,913 exports. Only 8 rows differ from the committed copy, all implementation statuses that changed in Canary since. Pointing it at a non-Canary directory exits with an error. No Rust changes. 🤖 Generated with [Claude Code](https://claude.com/claude-code)

fabi added 1 commit 2026-09-16 20:21:21 +00:00

docs(reference): adopt the last reference files from the project root

CI / Native — linux (pull_request) Successful in 2h0m10s

Details

CI / WASM — Web (pull_request) Successful in 28m47s

Details

CI / Formatting (pull_request) Successful in 1m29s

Details

75b546cf2f

Three untracked files in the project root had no home in either repository:

- the Xbox 360 technical reference report (a research compilation) becomes
  docs/reference/xbox360-re-technical-reference.md, unchanged;
- XBOX360_ARCHITECTURE.md becomes docs/reference/xbox360-architecture.md,
  trimmed to its platform facts. Its format "status" sections (PAK unknown,
  mesh unknown, audio TODO) and the `just sniff` workflow predate every
  decoder in this repo and were wrong;
- generate_export_docs.py becomes tools/generate_export_docs.py, the path the
  committed xbox360-exports.* already name as their generator. It lived
  inside a Canary checkout, so it now takes --canary and --out and fails
  loudly on a tree that is not Canary.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

fabi merged commit aef3cf09e1 into main

2026-09-17 05:11:10 +00:00

fabi referenced this issue from a commit

2026-09-17 05:11:16 +00:00

Merge pull request 'docs(reference): adopt the last reference files from the project root' (#46) from docs/adopt-root-reference into main

fabi referenced this issue from a commit

2026-09-19 20:29:49 +00:00

Merge pull request 'docs(reference): adopt the last reference files from the project root' (#46) from docs/adopt-root-reference into main

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: fabi/Sylpheed#46