codebase-wiki

Generates and refreshes a source-grounded markdown wiki of a codebase under wiki/.

Updated Sep 7, 2026
One-click install
npx skills add https://github.com/jcafeitosa/anxionOS --skill codebase-wiki-jcafeitosa
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: codebase-wiki
Source: https://github.com/jcafeitosa/anxionOS/tree/main/.cursor/skills/codebase-wiki
Command: npx skills add https://github.com/jcafeitosa/anxionOS --skill codebase-wiki-jcafeitosa

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Codebases lack navigable, up-to-date documentation that stays synchronized with the source. This Skill guides an agent to read the actual source code and author a version-controlled, diagram-rich markdown wiki under wiki/, then keep it fresh through incremental refreshes anchored to git commits. ## Core Features & Use Cases - Phased wiki generation: Survey the stack, then produce an OVERVIEW hub plus architecture, modules, flows, concepts, and guides sections with mermaid diagrams and source references. - Incremental refresh: Diffs source_commit..HEAD to update only affected pages and re-stamps the freshness anchor, with an append-only audit log in wiki/log.md. - Audience and depth profiles: Tune output with internal/public audience and tour/standard/exhaustive depth knobs recorded in frontmatter. - Use Case: After a large refactor, ask the agent to refresh the wiki; it diffs the last stamped commit against HEAD, updates only the changed module and flow pages, and logs the run. ## Quick Start Ask the agent to generate a wiki of this codebase at standard depth for an internal audience, then confirm the proposed coverage at the STOP gate.

Frequently Asked Questions about codebase-wiki

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a wiki for my codebase with an AI agent?▼

Seed the codebase-wiki pack with `ok seed --pack codebase-wiki`, then ask the agent to build the wiki. It surveys the source with native tools, proposes a page list at a STOP gate, and authors pages under wiki/ using OK MCP write/edit verbs.

How does the codebase wiki stay up to date after code changes?▼

OVERVIEW.md frontmatter stores a source_commit anchor. On refresh, the skill diffs source_commit..HEAD, updates only affected pages, re-stamps the commit, and appends a dated entry to wiki/log.md.

What is the difference between tour, standard, and exhaustive depth?▼

Tour produces only OVERVIEW, architecture, and top flows. Standard adds one page per module plus a concepts glossary. Exhaustive adds sub-module pages, task guides, and per-flow failure modes.

Does the codebase-wiki skill require the OpenKnowledge MCP server?▼

Yes. Authoring and auditing pages uses OK MCP write/edit/links/search verbs and requires the Hocuspocus server running via `ok start`. Source code reading uses native tools since OK does not index non-markdown files.

Why should wiki markdown not be written with native file tools?▼

Native Write/Edit bypasses attribution, backlink graph tracking, and the live preview. The skill mandates OK MCP write/edit so links register in the orphan/hub graph and broken-link validation runs on every write.