wikikit

Installation
SKILL.md

wikikit

The documentation a reader opens: how do I run this, how do I do the one task I came here for, how is it put together, and what do I do at 3am when it's down. wikikit generates that set from the codebase as it actually is, keeps it true as the code changes, and reports honestly when it has gone stale. It is not the GitHub Wiki tab, because everything it writes is in-repo Markdown, versioned with the code and reviewed in the same pull request. Mirroring that set out to the wiki tab is available as an opt-in publish mode, which never fires unless you ask for it by name.

A repo built by agents accumulates plans, reviews, QA docs, and decision records, and still ships a README that says npm install because that's what the scaffold wrote a year ago. The knowledge exists; it's just scattered across artifacts nobody outside the project will ever read. wikikit is the half that faces outward.

What wikikit is not

  • Not the GitHub Wiki. In-repo Markdown is the source of truth in every mode, versioned with the code and reviewed in the same PR. The wiki tab is at most a derived, disposable mirror, and only when publish is asked for by name. wikikit never reads the wiki as input and never treats it as canonical.
  • Not the domain model. A glossary (CONTEXT.md) and decision records (docs/adr/) have one owner, which is domainkit when it's installed and the human otherwise. A page that needs a term links to the glossary instead of defining it; an architecture page that needs a rationale links the ADR by number instead of paraphrasing it. A term missing from the glossary is routed, never invented inline.
  • Not process artifacts. Plans, QA plans, reviews, handoffs, and agent instruction files (CLAUDE.md and its equivalents) are written for a maintainer mid-flow, expire, and are never read as sources of truth for reader docs or written by this skill.
  • Not an API reference generator. Where a generator exists (TypeDoc, Sphinx autodoc, an OpenAPI spec) wikikit links its output unchanged rather than hand-writing reference material that drifts within a week.

When this fires

  • init. "Write docs for this project", "document this repo", "we have no docs", "generate a getting-started guide". Bootstraps the set from the codebase.
  • update. "Update the docs", "the docs are out of date after this change", or a docs pass right after a feature lands. Refreshes only what the change invalidated.
  • audit. "Are our docs stale", "check the docs against the code", "what's undocumented". Read-only sweep. Writes nothing, ever.
  • publish. Explicit ask only. "Publish the docs to the GitHub wiki", "sync docs/wiki/ to the wiki tab", "set up the wiki action". Installs a workflow that mirrors the set to the wiki.
Installs
142
Repository
mimukit/skills
GitHub Stars
1
First Seen
Aug 6, 2026
wikikit — mimukit/skills