Generate the English wiki pages from README.md and guides/ #43

Merged
Tirsvad merged 1 commits from mil-005-english-wiki-pages into main 2026-10-10 02:54:59 +02:00
Owner

Generates the English wiki pages for MIL-005 task 3.

Changes

  • tools/build_wiki.py builds Home, Onboarding, Credentials, Troubleshooting and Capabilities into wiki/ from README.md and guides/.
  • Links between pages become wiki links; links to other repository files become absolute links to the file on main; heading emoji is stripped so anchors are stable.
  • Each page starts with a notice that it is generated and that edits are overwritten.
  • --check exits 1 and lists pages that are missing or differ from their sources.
  • tests/test_build_wiki.py (18 tests, offline) covers the conversion and asserts the committed wiki/ is current, so the existing validation workflow fails on drift.

Notes

  • A change to the README or a guide now needs python tools/build_wiki.py and a commit of wiki/.
  • Danish and Bahasa Malaysia pages (tasks 4 and 5), the page naming (task 1) and publishing (task 8, #42) are not part of this PR.
  • Full test suite: 90 passed.

Closes #34

Generates the English wiki pages for MIL-005 task 3. ## Changes - `tools/build_wiki.py` builds Home, Onboarding, Credentials, Troubleshooting and Capabilities into `wiki/` from `README.md` and `guides/`. - Links between pages become wiki links; links to other repository files become absolute links to the file on `main`; heading emoji is stripped so anchors are stable. - Each page starts with a notice that it is generated and that edits are overwritten. - `--check` exits 1 and lists pages that are missing or differ from their sources. - `tests/test_build_wiki.py` (18 tests, offline) covers the conversion and asserts the committed `wiki/` is current, so the existing validation workflow fails on drift. ## Notes - A change to the README or a guide now needs `python tools/build_wiki.py` and a commit of `wiki/`. - Danish and Bahasa Malaysia pages (tasks 4 and 5), the page naming (task 1) and publishing (task 8, #42) are not part of this PR. - Full test suite: 90 passed. Closes #34
Tirsvad added 1 commit 2026-10-10 02:53:37 +02:00
Generate the English wiki pages from README.md and guides/
Validate workflows / validate (pull_request) Successful in 13s
8d62ea0d56
Add tools/build_wiki.py, which builds the five English wiki pages into
wiki/, rewrites links so they work inside the wiki and reports pages that
differ from their sources. Offline tests cover the conversion and assert
that the committed pages are current.

Task: MIL-005#3
Tirsvad merged commit 5ef76ec263 into main 2026-10-10 02:54:59 +02:00
Tirsvad deleted branch mil-005-english-wiki-pages 2026-10-10 02:55:04 +02:00
Sign in to join this conversation.