Wiki Maintenance

Wiki maintenance and publication

Reviewed: 2026-11-01 · Implementation: b7140848 · Availability: documentation for current main with explicit stable-release boundaries.

The wiki Git repository is the canonical page source. A documentation PR in the emulator repository does not publish the live wiki. Clone it separately:

git clone https://github.com/Mainkill1/xemu.wiki.git

The visible footer identifies the reviewed content revision. The actual published revision is the wiki Git repository's HEAD; publication receipts record that full hash after push. The emulator source identity and wiki publication identity answer different questions.

Current records and dated evidence

.wiki/current-changes.json is the reviewed post-September change register, including all 43 merges through the pinned source. Each record has problem, mechanism, source/PR, presence, stable availability, default/apply behavior, platform, evidence type/outcome, adverse/unknown results, owner and verification date. Its table is Current change register; earlier mechanisms are in Implemented.

first_stable_release=null means main-only at this review. An entry explicitly included in the latest stable can still have an undetermined first earlier release; do not guess it. Merge/close state, recommendation, source presence and shipping availability remain separate. Removal records describe retirement, not a currently available feature.

Current pages answer what exists now. Immutable reports answer what happened on their tested builds. Dated research answers why a route was investigated. Preserve failed runs, adverse outcomes, withdrawn percentages, accepted limitations and old recommendation boundaries. Update the current record and introduction together; do not append a correction below a still-false summary.

Prepublication checks

Run from the wiki clone, with a local emulator repository containing the pinned source:

python3 .wiki/test_check_wiki.py
python3 .wiki/check_wiki.py --source /path/to/xemu
git diff --check

The standard-library checker rejects pipe-containing wiki links inside tables, inconsistent column counts, missing wiki targets, wrong fragments, missing maintained-page review metadata, feature-table/record disagreements and nonexistent source paths at the declared SHA. It scans historical pages for structural links but only requires current metadata for pages listed in .wiki/current-pages.json. The original slash-heading regression is pinned in tests: PFIFO / MMIO becomes #pfifo--mmio, preserving both surrounding spaces.

Offline heading checks implement GitHub's punctuation removal and duplicate suffixes for this corpus; published heading IDs are the final authority. After publication, compare them with the actual href/id emitted by GitHub, including both corrected Performance-Unproven anchors. A local parse cannot establish network availability, JavaScript rendering, pixel layout or Mermaid runtime success.

Review every feature change against its PR and pinned source: default, platform, restart behavior, partial proposal completion, removals and first release. The checker detects record drift, but cannot infer semantic availability from a merged title or prove a game gain. Ambiguous/reverted source needs human review. Link release notes and current indexes to the same records.

Publish and verify

1. Pull/check the remote wiki head before editing; use a review branch. Keep source-side documentation changes in their owning emulator PR.
2. Inspect current page introductions, diagrams/pseudocode, repeated references, navigation and evidence links. Render long tables and representative diagrams; inspect a narrow window as well as desktop.
3. Run the checks above. Confirm no runtime or raw benchmark payload entered the product patch. Documentation-only runtime performance is N/A; this does not alter earlier runtime qualification.
4. Commit the reviewed wiki content, record its hash in the publication footer/receipt, then push to the wiki default branch after reviewing the complete diff.
5. Read the live affected pages. Compare headings/anchors, clickable labels, table cell alignment and review date with the intended revision. Recheck a suspected diagram/network failure once; distinguish missing targets, auth/rate limits, transient service errors and malformed nonlinks.
6. Verify remote HEAD matches the published revision and retain a compact completion receipt linking source SHA, content SHA, actual publication SHA and any unverified visual/platform checks.

Review ownership

Topic owners can review graphics, audio/CPU, user operation and evidence independently. Release review reconciles a new tag against the current register and tests published navigation. No scheduled task or recurring automation is created by this page. Keep the original September snapshot accessible as history, and route present-day readers through Current status.