Technical Documentation
The in-depth technical documentation lives in the repository's docs/ folder. This page is an index to help you find the right document.
Index
| Document | Purpose |
|---|---|
| BUILD | Compile, run, test and smoke scripts |
| LAUNCH_APP | Launchers and JavaFX notes |
| ARCHITECTURE | Packages, UI layout, storage, events |
| ARCHITECTURE_GUIDELINES | Normative architecture and growth rules |
| I18N | Supported locales and how to add a new language |
| PLUGINS | External plugin JAR workflow |
| PACKAGING | Platform packaging scripts |
| CICD | GitHub Actions CI/CD and release workflow |
| TESTING | Test strategy, commands, and guard-test rules |
| EVENT_BUS_CONTRACT | Event bus usage rules |
| GIT | Vault Git integration and sync panel |
| GRAPH | Knowledge graph and Knowledge Insights |
| DATAVIEW | Dataview plugin: query language, metadata sources, indexing |
| MCP | MCP server plugin: exposed tools, transport, dependency bundling |
| SEARCH | Advanced search syntax and architecture |
| WORKSPACES | Saved workspace behaviour and persistence |
Spanish
Technical docs are mirrored in Spanish under docs/es/.