Skip to content

docs: make the GitHub wiki a lightweight index of the docs site #189

Description

@bioedca

Why

The repository has a wiki that is currently empty, so it competes with the MkDocs site as a documentation destination and gives anyone who lands there nothing. Rather than disabling it, it should become a thin signpost that routes readers to the real documentation.

Evidence

Deliverables

Acceptance criteria

  • The wiki Home page renders with every link resolving (check each by loading it).
  • The page contains no substantive documentation content — only orientation and links. Anything longer than a paragraph belongs on the docs site.
  • No link points at a dev docs tree; all point at latest or the un-versioned root that redirects to it.

Constraints

  • This is an index, not a second home. Any content added here will drift out of sync with the docs site, which is exactly the failure mode that made the wiki worth addressing.
  • Wiki content lives in a separate git repository (.wiki.git) and is not covered by this repo's REUSE configuration or CI — it will not be linted or link-checked, which is another reason to keep it to a single short page.
  • latest currently aliases dev. versions.json holds exactly [{"version":"dev","title":"dev","aliases":["latest"]}] because v1.0.0 has not been cut and docs.yml refuses to alias latest to a pre-release. Linking /latest/... therefore satisfies the "no dev tree" criterion above and is the correct thing to write — do not "fix" it to a version number, and do not link /dev/... directly.
  • Prior work exists; do not restart from zero and do not resume it wholesale. Closed-unmerged draft PR docs(docs): add reviewed GitHub wiki index #251 left branch docs/issue-189-github-wiki-index at 350cc37 on origin, carrying reusable files (.github/workflows/wiki.yml, wiki/Home.md, the mkdocs.yml and docs/adr/README.md edits). It is +985/−0 across 8 files, roughly 6.5× the size:S budget — see the 2026-07-29 comment for the per-file disposition. Harvest from it, then let the branch be deleted. refs/adr-reservations/0058 (44bb596) is still held on origin; decide its disposition in the same PR — under the current contract an ADR is authored only when the issue carries needs:adr, and this issue does not.

Meta

Grooming status — 2026-07-27

Metadata

Metadata

Assignees

No one assigned

    Labels

    agent:claudeClaimed by the Claude worker lanearea:docsDocs site (mkdocs) / docstringspriority:P2Mediumrisk:lowDeclared risk: low. Routes nothing - every PR walks the same lane. May only increase.size:SDiff budget <=150 changed lines (excl. lockfiles/generated)status:in-progressIn progresstype:docsDocumentation

    Projects

    Status
    Ready

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions