Skip to content

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)

  1. Contributing guide — build, test, MSRV
  2. OntoCore crate map — façade vs ontocore-* layout
  3. Design architecture — crate responsibilities
  4. Run ./scripts/run-ci-local.sh before opening a PR

Extension-only (VS Code + OntoUI)

  1. Extension developmentextension/ layout, F5, tests
  2. Debugging guide — LSP output, webview devtools
  3. Webview protocol — host ↔ React messages
  4. cargo build -p ontocore-lsp --bins then cd extension && npm run compile && npm test

Docs-only

  1. Contributing guide — mirror rules for VISION.md / ARCHITECTURE.md / ROADMAP.md
  2. ./scripts/check-doc-versions.sh and mkdocs build --strict
  3. Documentation index — find the right page to edit

LSP / custom editor integrators

  1. LSP hello world — minimal stdio client
  2. LSP API reference — shipped v0.13 methods
  3. Do not use design/LSP_SPEC.md for current behavior (future target)

Start here for contributors

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.