Wiki Maintenance

Wiki maintenance

The wiki is a separate Git repository. Its builder reads existing documentation from rebuild/main and gh-pages and writes only this wiki checkout. It does not push, edit the source checkouts, run docs-sync.yml, change translations, or deploy the website.

Where to make a correction

• Task guides: edit the corresponding gh-pages HTML page through the project's normal review process.
• Detailed references: edit the corresponding Markdown document on rebuild/main.
• Generated external-tools sections: edit the templates in .github/workflows/docs-sync.yml; direct edits to their generated source output will be overwritten by the existing workflow.
• Wiki homepage, navigation, source mappings and conversion: edit _tools/build.py in this wiki repository.

Every imported page has an exact source-commit link at the bottom. Correct its source, then regenerate the wiki. Direct edits to imported wiki pages are overwritten on the next rebuild. Integration plans and the internal documentation gap checklist are not published as user guides; links to those files remain links to the source repository.

Rebuild

During the C++ migration, refresh only guides whose source port is complete. The full builder retains production source mappings, and rebuilding every guide from older migration Markdown can erase newer imported documentation. _tools/update_selected.py preserves unrelated pages and their original pins, records the new per-page source commits, and validates the complete Wiki's links. For the merged POPS UDPFS port, use clean sibling checkouts:

python _tools/update_selected.py --source ../RiptOPL --site ../RiptOPL-site --pages Project-Overview PS1-Games PS1-Reference Troubleshooting --pops-only

For the merged Favorites default/remembered-shelf port, refresh only those paragraphs in the two affected guides:

python _tools/update_selected.py --source ../RiptOPL --site ../RiptOPL-site --pages Favorites Troubleshooting --favorites-only

Review the generated diff before committing. This helper writes only the Wiki checkout and does not push or deploy anything. The manifest's complete-import pins remain historical; partial_updates and each page's footer identify newer selected updates. --pops-only also preserves unrelated sections within each selected guide and retains their original source footer. --favorites-only does the same for Favorites view guidance. Scoped updates preserve each other's provenance footers when either is repeated. Preserve the imported RA guide until its source/runtime port is complete.

Use Python 3.10 or newer, Git, and three separate sibling directories. The source and site checkouts must be clean. Existing working copies are also accepted by the builder.

git clone --depth 1 --single-branch --branch rebuild/main https://github.com/NathanNeurotic/Open-PS2-Loader.git source
git clone --depth 1 --single-branch --branch gh-pages https://github.com/NathanNeurotic/Open-PS2-Loader.git site
git clone https://github.com/NathanNeurotic/Open-PS2-Loader.wiki.git wiki
cd wiki
python -m venv .venv

Activate the environment with .venv\Scripts\activate on Windows or source .venv/bin/activate on Linux/macOS, then run:

python -m pip install -r _tools/requirements.txt
python _tools/build.py --source ../source --site ../site
git diff --check
git diff --stat
git diff

The builder fails on missing source pages, dirty source checkouts, duplicate page names, unresolved wiki links or section anchors, and unexpected output files. It checks that conversion preserves text, tables and code examples. Run it again with the same inputs: generated file hashes must be identical. Source checkouts are checked again at the end to ensure their tracked and untracked state did not change.

Review the content before committing and pushing the wiki repository. Use a normal push that preserves history; concurrent edits must be reconciled. There is no automatic publication job or additional credential configured by this setup.

Coverage and source revisions

For Favorites staged saves and recovery, update the persistence section without replacing view guidance or other imported content:

python _tools/update_selected.py --source ../source --site ../site --favorites-storage-only --pages Favorites

This records a separate Favorites storage source/site revision and preserves the existing view, POPS and VMC update footers. Repeat with the same clean inputs to verify that generated files remain unchanged.

For the VMC safety follow-ups, update only the affected sections and preserve other imported content and its original source pins:

python _tools/update_selected.py --source ../source --site ../site --vmc-only --pages Virtual-Memory-Cards Settings Troubleshooting

The helper records VMC-specific source/site revisions, checks all Wiki links and anchors, and asserts that unselected pages remain unchanged. Repeating it with the same clean inputs must leave the generated files unchanged. This avoids regenerating newer imported RA guidance from an older source document.

• Source: 679582deddf5
• Website: 0a6143cd8956
• All website HTML pages are included, with explicit source-to-wiki mappings.
• The complete README, release reference and selected user/developer Markdown guides are included.
• _tools/manifest.json records source revisions, per-page origins, output hashes and validation counts.

Website search, styling and JavaScript controls belong to the website. In the wiki, tables are static and expandable explanations are shown in full. Content, code examples, and section destinations are preserved. Site and source guides may overlap; paired pages link to one another and retain their source provenance rather than silently combining potentially different instructions.