OntoIndex + OntoCode Documentation Package¶
Note: Documents in this folder describe product vision, target architecture, and planned features. They are not commitments. For what ships in v0.8.0, see What ships today. For planning without fixed dates, see Release timeline (non-commitment).
This package contains product vision and specification documents. For user-facing guides, pick a documentation path:
| Path | Audience | Start |
|---|---|---|
| VS Code extension | Explorer, inspector, Query Workbench, reasoner panels | Marketplace install, no Rust required |
| Rust & CLI | ontoindex CLI, crates.io libraries, CI, LSP integrators |
cargo install ontoindex-cli |
Documentation home · What ships today
| Package | Audience |
|---|---|
| User docs (paths above) | New users and integrators |
docs/design/ (this folder) |
Contributors and planners (roadmap, target architecture, ADRs) |
Two related products:
- OntoIndex — Rust ontology index/query engine (
ontoindex-*crates). - OntoCode — VS Code extension (explorer, diagnostics, Turtle + Manchester authoring, Query Workbench, reasoner in v0.6).
Sibling project: OntoLogos — Rust ontology reasoner. OntoCode delegates reasoning to OntoLogos per ADR-0015.
Dependency policy: ADR-0016 — thin ontoindex-* facades over mature crates. Inventory: DEPENDENCY_MATRIX.md. Licenses: LICENSES.md.
v1.0 exit bar¶
PROTEGE_PARITY.md — canonical P0/P1/P2 checklist for Protégé-competitive release.
Document status¶
Many specs describe target behavior. Check the banner at the top of each doc, or:
- Implemented v0.6 LSP: LSP API — includes
query,sparql,parseManchester,runReasoner,getExplanation - Implemented reasoner: Reasoner guide
- Implemented SQL tables: SQL reference
- Implemented authoring: authoring guide
- ADRs (canonical): adr/README.md
Documents¶
Product & roadmap¶
- PLAN.md — combined product plan
- ROADMAP.md — milestone roadmap v0.1 → v1.0
- DEPENDENCY_MATRIX.md — external crate inventory
- LICENSES.md — third-party license summary
- PROTEGE_PARITY.md — v1.0 compete checklist
- v1.0_BACKLOG.md — implementation backlog
Technical specs¶
- SPEC.md — combined technical specification
- ARCHITECTURE.md — target architecture
- OWL_AUTHORING_SPEC.md — hybrid forms + Manchester authoring
- OBO_ROBOT_SPEC.md — OBO format + ROBOT interop
- REASONER_SPEC.md — OntoLogos-backed reasoners (0.9.0 → 1.0.0)
- SHACL_SPEC.md — SHACL validation (P1)
- SEMANTIC_DIFF_SPEC.md — semantic ontology diff
- LSP_SPEC.md — target language server (v1.0 methods)
- PLUGIN_SPEC.md — plugin system
UX¶
- UI_WIREFRAMES.md — text-based VS Code wireframes
- OntoCode_React_UI_Integration_Plan.md — React webview migration (v0.7a → v1.0, ADR-0017)
Historical / backlog¶
- MVP_BACKLOG.md — v0.1/v0.2 backlog
- adr/README.md — architecture decision records