# Documentation

The hub for cite-citadel's docs. Start with the [README](../README.md) for the pitch and
quickstart; come here when you know what you want to do.

## I want to…

| I want to… | Read |
|------------|------|
| Install it and build my first wiki | [README — Quickstart](../README.md#quickstart) |
| Configure the knobs / run a local model | [configuration.md](configuration.md) |
| Keep the wiki's history in git (auto-commit after ingest, push to GitHub/GitLab) | [configuration.md § Wiki history](configuration.md#wiki-history-git) |
| Hook up an AI client (Claude Desktop, Claude Code, …) over MCP | [mcp.md](mcp.md) |
| Capture knowledge from conversations (notes + transcripts) | [capture.md](capture.md) |
| Sync the wiki across devices / read it on my phone | [recipes.md § Sync](recipes.md#sync-across-devices) |
| Run ingest + refresh on a schedule (cron, systemd, Task Scheduler, a scheduled agent) | [recipes.md § Scheduled runs](recipes.md#scheduled-runs) |
| Improve/clean up existing pages | [maintenance.md § Curate](maintenance.md#curate) |
| Re-verify old imports after a model upgrade, on a monthly budget | [maintenance.md § Refresh](maintenance.md#refresh) |
| Change how the wiki is built | [maintenance.md § Rules](maintenance.md#rules) |
| Fix something that's broken | [troubleshooting.md](troubleshooting.md) |
| Understand the OKF page format | [okf-reference.md](okf-reference.md) |
| Read the founding idea | [karpathy-llm-wiki.md](karpathy-llm-wiki.md) |
| See where citadel stands vs. the landscape, and what's still missing | [audit-2026-07.md](audit-2026-07.md) |
| See which corpus-grading misses are still open (the two optimization lanes) | [verify-corpus-backlog.md](verify-corpus-backlog.md) |
| Contribute | [CONTRIBUTING.md](../CONTRIBUTING.md) |
| Understand how it works inside (the contributor/agent bible) | [CLAUDE.md](../CLAUDE.md) |

## What's here

```
docs/
├── index.md               ← you are here
├── configuration.md       every CITADEL_* env var + local-model (Ollama) recipes
├── maintenance.md         curate, refresh, status, and customizing the rules (eject / local.md)
├── mcp.md                 wire the MCP server into an AI client
├── capture.md             the conversation→raw/ bridge: wiki_capture + transcript files
├── recipes.md             multi-device sync (git, sync services, phone) + scheduled runs (cron/systemd/agent)
├── troubleshooting.md     symptom → cause → fix; leads with `citadel doctor`
├── okf-reference.md       the Open Knowledge Format the wiki pages use
├── karpathy-llm-wiki.md   the LLM-Wiki pattern this implements
├── audit-2026-07.md       point-in-time audit: internal gaps + landscape comparison + backlog
└── verify-corpus-backlog.md  durable ledger of corpus-grading misses (the two optimization lanes)
```

The rules the ingest agent actually follows live in
[`citadel/rules/`](../citadel/rules/README.md) (packaged with the wheel), not here.
