codewiki

name	codewiki
description	Use this skill when the user wants Codex to generate or refresh CodeWiki wiki pages from local repository evidence without relying on CodeWiki's external LLM-backed wiki generator.

CodeWiki

Use this skill when the user wants Codex to generate or refresh CodeWiki wiki pages from local repository evidence without relying on CodeWiki's external LLM-backed wiki generator.

Workflow

1. Make sure the repository is registered and analyzed:
   • codewiki repos add <path-or-url> --json
   • codewiki analyze <repo> --json
2. Plan the wiki queue:
   • codewiki wiki plan <repo> --language en --json
3. For each page slug, fetch compact evidence:
   • node <skill-dir>/scripts/compact-evidence.mjs <slug> <repo> --language en --limit 5
   • Use a lower --limit for simple pages. Raise it only when validation or obvious gaps require more evidence.
   • Fall back to codewiki wiki evidence <slug> <repo> --language en --limit 3 --json only when the compact script is unavailable.
4. Write Markdown using only the compact evidence.
   • Cite claims with [[S#]] citation IDs from allowed_source_refs.
   • Follow references/page-style.md for page shape.
5. Save the page:
   • codewiki wiki save <slug> <repo> --language en --title "<title>" --stdin --json
6. Validate and repair until valid:
   • codewiki wiki validate <slug> <repo> --language en --json
7. Export the generated wiki to one standalone HTML file:
   • node <skill-dir>/scripts/export-html.mjs <repo> --language en --output codewiki-wiki.html

<skill-dir> is this skill folder. In a default Codex install it is usually $CODEX_HOME/skills/codewiki.

MCP Tools

When CodeWiki MCP is available, prefer these tools for planning, saving, and validation:

• codewiki_wiki_plan
• codewiki_wiki_page_save
• codewiki_wiki_page_validate

For page evidence, prefer scripts/compact-evidence.mjs because raw MCP evidence can be too large for the agent context. Use codewiki_wiki_evidence only as a fallback with limit <= 3, then keep only page, catalog_context, allowed_source_refs, and short source_chunks.content excerpts before writing.

Always fetch compact evidence before writing a page. Do not paste full retrieval_trace.context, context_pack, large chunk bodies, or unrelated nodes into the conversation. Do not invent source claims, file paths, APIs, or architecture facts that are absent from the compact evidence pack.