De-slop internal docs + config (repo now fully em-dash-free) (#98)
Sync course wiki / sync-wiki (push) Successful in 4s
Sync course wiki / sync-wiki (push) Successful in 4s
Co-authored-by: claude <claude@jpaul.io> Co-committed-by: claude <claude@jpaul.io>
This commit was merged in pull request #98.
This commit is contained in:
+3
-3
@@ -1,10 +1,10 @@
|
||||
# tools/
|
||||
|
||||
## `build_wiki.py` — render the course into a wiki
|
||||
## `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.
|
||||
**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),
|
||||
@@ -35,7 +35,7 @@ For GitHub, use `--host github` and `--web-base https://github.com/<owner>/<repo
|
||||
|
||||
Both need, one time:
|
||||
1. an **Actions runner** attached (Gitea: Settings → Actions → Runners);
|
||||
2. a repo secret **`WIKI_TOKEN`** with wiki write (a scoped PAT/deploy token — *not*
|
||||
2. 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);
|
||||
3. the wiki **initialized** once (Gitea is already initialized; on GitHub create one
|
||||
page in the UI first so `<repo>.wiki.git` exists).
|
||||
|
||||
Reference in New Issue
Block a user