# CodeWiki Plugin Documentation

Welcome to the documentation for the **CodeWiki Standalone Agent Plugin**.

CodeWiki equips coding agents with eight modular skills for generating, incrementally synchronizing, retrieving, and visualizing source-grounded repository knowledge bases.

> **Citation & Attribution**: CodeWiki is built on and adapted from [LangChain's OpenWiki](https://github.com/langchain-ai/openwiki) and inspired by the repository-level documentation paradigm pioneered by [Cognition AI's DeepWiki](https://deepwiki.com).

---

## Documentation Sections

1. [Architecture & Design Principles](architecture.md)
   - Core design philosophy
   - Runtime independence and zero external dependencies
   - Agent-native execution model
   - Falsifiable claims grounding and drift detection

2. [Installation & Setup](installation.md)
   - Supported hosts: Antigravity, Codex, Upstream Pi, Claude Code, Cursor, and OpenCode
   - Automated installation via `setup.mjs`
   - Native Pi package integration
   - Claude Code and Codex plugin manifests

3. [Skills Reference](skills-reference.md)
   - `wiki-init`: Grounded repository taxonomy and documentation generation
   - `wiki-update`: Incremental sync, drift analysis, and claim reconciliation
   - `wiki-query`: Precision retrieval with source verification
   - `claims-grounding`: Falsifiable proposition sidecars and line-exact evidence hashing
   - `okf-format`: Open Knowledge Format (OKF v0.2) compliance and navigation indexes
   - `mermaid-diagrams`: Source-grounded architecture and workflow diagrams
   - `wiki-workspace`: Multi-repository documentation workspaces
   - `wiki-visualize`: Standalone interactive browser visualization

4. [Output Contract & Directory Layout](output-contract.md)
   - The `codewiki/` directory structure
   - Sidecar storage in `codewiki/.claims/`
   - Page manifest (`.page-manifest.json`) and run state (`.codewiki-run.json`)
   - Ignore semantics (`.codewikiignore`)

5. [Claims Helper CLI Reference](claims-helper-cli.md)
   - Using `claims.mjs` for hashing, ID generation, and validation
   - `source-id`, `claim-id`, `evidence-version`, `hash-page`, `snapshot`, `verify`
   - Algorithm specifications for line hashing and context windows

6. [Testing & Parity Verification](testing-and-verification.md)
   - Running the test suite (`npm test`)
   - Upstream compatibility tests (`CODEWIKI_SOURCE_ROOT`)
   - Verification boundaries

---

## Citations & Upstream References

- **LangChain OpenWiki:** [github.com/langchain-ai/openwiki](https://github.com/langchain-ai/openwiki)
- **DeepWiki:** [deepwiki.com](https://deepwiki.com)