Documentation
Docs are on the way.
PKMA is in alpha. Proper docs land alongside the v1 release; in the meantime the source repo is the most up-to-date reference.
Until docs are ready
- The source repo README covers install, build-from-source, and the supported provider list.
- The home page architecture section sketches how the retrieval pipeline is wired.
- The agent modes section explains what each mode is good for.
What docs will cover at v1
- Install & first launch — per-platform binaries, code signing notes, picking a vault.
- Providers — wiring up local (Ollama, llama.cpp) and cloud (OpenAI-compatible) models, picking embedding dimensions.
- Agent modes — when to use Quick, Deep, and Research; cost/latency trade-offs.
- Vault tips — folder structure, wikilink hygiene, what PKMA ignores.
- Troubleshooting — log locations, index rebuilds, common provider errors.