wiki maintenance

Wiki maintenance

Summary: docs/wiki/ is the single source of truth and the complete information source for sloth. The GitHub wiki is a render of it, published automatically. This page states how the sync works and the standing rule: an agent that changes sloth's behaviour updates the wiki in the same change.

Sources: .github/scripts/wiki_sync.sh, .github/workflows/wiki-sync.yml, docs/CLAUDE.md, agents/AGENTS.md.

Last updated: 2026-09-30.

---

Source of truth

Edit docs/wiki/*.md. Never edit pages in the GitHub wiki UI — they are overwritten on the next push. The GitHub wiki carries a _Footer.md saying exactly this.

How the sync works

.github/scripts/wiki_sync.sh renders docs/wiki/ into a checkout of sloth.wiki.git. It is mechanical and idempotent:

• index.md → Home.md (GitHub's landing page name).
• YAML front matter is stripped.
• ](https://github.com/SpaceTrucker2196/sloth/blob/main/docs/views/…), ](https://github.com/SpaceTrucker2196/sloth/blob/main/docs/personas/…), ](https://github.com/SpaceTrucker2196/sloth/blob/main/…) become absolute blob/main URLs (the wiki has no repo tree beside it).
• ](sibling) → ](sibling) (wiki page links).
• [[wiki-links]] are left as-is — GitHub's wiki resolves them.
• _Sidebar.md is generated from index.md's headings and [[links]].
• A page deleted from docs/wiki/ is deleted from the wiki.

.github/workflows/wiki-sync.yml runs it on every push to main that touches docs/wiki/**. So the wiki can never drift from the repo by more than one push. To publish by hand:

git clone https://github.com/SpaceTrucker2196/sloth.wiki.git /tmp/wiki
sh .github/scripts/wiki_sync.sh docs/wiki /tmp/wiki          # push
sh .github/scripts/wiki_sync.sh docs/wiki /tmp/wiki --no-push  # dry preview

The standing duty (do agents keep the wiki updated? — yes)

This is the answer to "do agents keep the wiki update": it is a rule, not a hope. From agents/AGENTS.md and docs/CLAUDE.md:

• A behaviour change updates its page in the same change. New view → views-catalog + a per-view doc. New alert → alerts and a research/ citation (research-corpus, enforced by tests/test_research_corpus.c). New or changed flag → cli-reference. New WiFi vuln or generation → wifi-state-of-the-art.
• Two enforcement layers already exist. The risk gate scores any touch of agents/ at +40 (agents/FACTORY.md §10.3), and the docs-drift-judge GitHub Action audits per-view docs against their source files. The wiki-sync workflow is the third: it keeps the published copy honest.
• Page format (docs/CLAUDE.md): every page carries **Summary**, **Sources**, **Last updated**, content, then ## Related pages; after any change, update index.md and append to log.md.

Lint (on request)

Check for: contradictions between pages, orphan pages (no inbound [[link]]), concepts mentioned but lacking a page, pages drifted from the code they cite, and format violations. Report as a numbered list with fixes. See docs/CLAUDE.md.

Related pages

• what-sloth-does — the top of the reference this wiki completes.
• docs-drift-judge — the per-view doc auditor.
• research-corpus — the enforced citation half of the same discipline.