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 .github/scripts/wiki_sync.py on rebuild/main through a normal PR.

Every imported page or source index 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

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
git -C source fetch origin 02ddafcfa212db742d58d0de25aec9521be29d01
git -C source checkout --detach FETCH_HEAD
git -C site fetch origin 00e273e37093e5f7ea6b525ff71eb970d5aefe5a
git -C site checkout --detach FETCH_HEAD
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 ../source/.github/requirements-docs.txt
python ../source/.github/scripts/wiki_sync.py --source ../source --site ../site --wiki .
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

• Source: 02ddafcfa212
• Website: 00e273e37093
• All website HTML pages are included, with explicit source-to-wiki mappings.
• Current user/developer references are included. Overlapping references keep their old URLs and anchors as short indexes pointing to the current guide and pinned source sections.
• _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. Overlapping guides use one wiki reading page plus a short source-section index. Unique source references remain complete. Legacy page names and heading anchors are preserved.