Files

T

claude f0cb2382c8 feat(wiki): generate the course textbook into the wiki from modules/ via CI

- tools/build_wiki.py: host-agnostic generator — renders modules/** + capstone
  into wiki pages with a unit-by-unit _Sidebar, a Home TOC, and a _Footer;
  rewrites lab/ and repo-root links to absolute repo URLs (labs stay in the repo,
  linked not copied). Single source of truth stays in modules/.
- .gitea/workflows/sync-wiki.yml + .github/workflows/sync-wiki.yml: sync the wiki
  on every push to main touching modules/**, capstone/**, README, or the generator.
  Documented prerequisites: an Actions runner + a WIKI_TOKEN secret (+ GitHub wiki
  must be initialized once).
- tools/README.md: how to run the sync manually and via CI.
- README: "Read it as a book" pointer to the wiki.

The Gitea wiki has already been populated with the initial render.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TfzV5QvtPDz8LJS3Pu5VLT

2026-06-22 18:53:01 -04:00

1.7 KiB

Raw Blame History

tools/

`build_wiki.py` — render the course into a wiki

The course wiki (the "textbook" view under the Wiki tab) is generated build output. The single source of truth is modules/**/README.md + capstone/README.md. Never hand-edit the wiki — edits there are overwritten on the next sync.

build_wiki.py is host-agnostic: it writes Markdown pages into a wiki working directory (Home.md, _Sidebar.md, _Footer.md, one page per module + capstone), rewriting lab/… and repo-root links to absolute URLs back in the main repo (so the runnable labs stay in the repo and are linked, never copied into the wiki).

Run it manually

# clone the wiki repo (Gitea)
git clone https://git.jpaul.io/justin/ai-workflow-course.wiki.git wiki

# render into it
python3 tools/build_wiki.py --repo-root . --out wiki \
    --web-base https://git.jpaul.io/justin/ai-workflow-course --branch main --host gitea

# publish
cd wiki && git add -A && git commit -m "docs(wiki): sync from modules/" && git push

For GitHub, use --host github and --web-base https://github.com/<owner>/<repo>.

Automated sync (CI)

Gitea: .gitea/workflows/sync-wiki.yml runs on every push to main that touches modules/**, capstone/**, README.md, or this generator.
GitHub: .github/workflows/sync-wiki.yml does the same on the mirror.

Both need, one time:

an Actions runner attached (Gitea: Settings → Actions → Runners);
a repo secret WIKI_TOKEN with wiki write (a scoped PAT/deploy token — not a site-admin token; on GitHub the default GITHUB_TOKEN can't push the wiki);
the wiki initialized once (Gitea is already initialized; on GitHub create one page in the UI first so <repo>.wiki.git exists).

1.7 KiB Raw Blame History

tools/

build_wiki.py — render the course into a wiki

Run it manually

Automated sync (CI)

1.7 KiB

Raw Blame History

`build_wiki.py` — render the course into a wiki