Internals (design targets)¶
These pages describe target architecture and contributor specs — not necessarily what ships in the current release.
For product capabilities, use What ships today. For a 10-minute tutorial, use First success.
Design documents, ADRs, and backlogs live under design/. Platform implementation architecture: platform/OVERVIEW.md. Product UX specs: ui/README.md — mapped to releases in ROADMAP_MAPPING.md. Product ADRs: adr/README.md. Cursor prompts: cursor-prompts/README.md. Always cross-check SHIPPED.md. See also Roadmap hub and Glossary.
Contributor paths by role¶
Rust-only (OntoCore crates)¶
- Contributing guide — build, test, MSRV
- OntoCore crate map — façade vs
ontocore-*layout - Design architecture — crate responsibilities
- Run
./scripts/run-ci-local.shbefore opening a PR
Extension-only (VS Code + OntoUI)¶
- Extension development —
extension/layout, F5, tests - Debugging guide — LSP output, webview devtools
- Webview protocol — host ↔ React messages
cargo build -p ontocore-lsp --binsthencd extension && npm run compile && npm test
Docs-only¶
- Contributing guide — mirror rules for
VISION.md/ARCHITECTURE.md/ROADMAP.md ./scripts/check-doc-versions.shandmkdocs build --strict- Documentation index — find the right page to edit
LSP / custom editor integrators¶
- LSP hello world — minimal stdio client
- LSP API reference — shipped v0.13 methods
- Do not use design/LSP_SPEC.md for current behavior (future target)
Start here for contributors¶
- Documentation index
- Glossary
- Platform architecture
- Contributing guide
- Extension development
- Debugging guide
- Cursor implementation prompts
- Design overview
- Product design / UI specs
- UI roadmap mapping
- OntoCore implementation architecture
- Product ADRs
- Engineering ADRs
- Releasing
Plugin model¶
The plugin host is a v0.14 design with an experimental ontocore-plugin discovery crate — not a stable API in v0.13. See plugin model and PLUGIN_SPEC.md.