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¶

Start with Architecture tour (~15 min) for a single map of crates, LSP, extension, and webviews.

Rust-only (Strixonomy crates)¶

1. Contributing guide — build, test, MSRV
2. Testing matrix — commands by change type
3. Strixonomy crate map — façade vs strixonomy-* layout
4. Design architecture — crate responsibilities
5. Run ./scripts/run-ci-local.sh before opening a PR

Extension-only (VS Code + OntoUI)¶

1. Extension development — extension/ layout, F5, tests
2. Debugging guide — LSP output, webview devtools
3. Webview protocol — host ↔ React messages
4. cargo build -p strixonomy-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 ./scripts/build-docs.sh
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 methods through the current tagged release (v0.27)
3. 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
• Strixonomy implementation architecture
• Product ADRs
• Engineering ADRs
• Releasing

Plugin model¶

Plugin SDK 1.0 freezes the TOML + subprocess JSON wire (api_version = "1") — safe to author against today. A curated marketplace and production owlmake integration remain product 1.0 goals. See plugin model, Plugin policy, and Plugin authoring guide (canonical).