Functionalities¶
Per-feature reference, split by topic. The full content used to live in this single file; it now lives under docs/features/ so each area is short enough to skim and easy to edit independently. The table below is the authoritative routing index — start here.
Per feature¶
| Page | Covers |
|---|---|
| Infrastructure & quality | Compose, tests, error handling, code splitting, typecheck |
| Documents | Document channels, upload, parsing pipeline (PaddleOCR-VL), openkms-cli |
| Articles | Article channels, CRUD, relationships, lifecycle, attachments, bulk import |
| Knowledge bases | KB CRUD, FAQs, chunks, semantic search, QA proxy, kb-index |
| Wiki spaces | Wiki pages/files, vault import, graph view, Wiki Copilot agent |
| Evaluation | Evaluation datasets, runs, compare |
| Glossaries | Bilingual terms, AI suggestion, import/export |
| Knowledge map & home | Taxonomy nodes, resource links, home hub graph |
| Global search | /search page: documents, articles, wiki spaces, knowledge bases (name, channel, updated filters) |
| Ontology — objects, links, datasets | Object/link types, instances, Object Explorer, data sources, datasets |
| Pipelines, jobs & models | Pipeline templates, procrastinate jobs, provider/model registry |
| Console & authentication | Permission catalog, data security, OIDC/local auth, system settings, user Settings (API keys) |
| OpenCode skill (openkms) | Agent skill + CLI against the REST API (openkms-skill/, install to ~/.config/opencode/skills/) |
Cross-cutting reference¶
| Page | Covers |
|---|---|
| API reference | One table of every HTTP endpoint, grouped by area |
| Data models | Schema for every persisted table |
| Configuration | Backend deps, pgvector, S3/MinIO, cursor rules |
Where to add new content¶
When something changes in code, edit the most specific page in the table above:
- New endpoint → matching feature page and API reference.
- New schema column → Data models and the feature page that uses it.
- New feature surface → its dedicated feature page; if no page fits, add a new file under
docs/features/, link it here, and add anav:entry inmkdocs.yml.
See Doc conventions for AI agents for the full editing checklist.