Technical Reference
August 8, 2026 · View on GitHub
In-depth technical documentation. See also the docs index for the full documentation map.
| Reference | Description |
|---|---|
| Architecture | System design and internals |
| Architecture Diagrams | Workspace dependency graph and other architecture diagrams |
| VelesQL Cheat Sheet | One-page quick reference: search, filter, graph MATCH, fusion, sparse, EXPLAIN |
| VelesQL Contract | Canonical REST contract (/query, /match, error model) |
| VelesQL Conformance | Cross-ecosystem conformance matrix |
| Ecosystem Sync Report | Feature parity matrix across all components |
| MCP Tool Reference | velesdb-memory: every MCP tool, one section each — parameters, returns, limits, error model |
| Performance SLO | CI-enforced performance objectives and budget gates |
| REST API | HTTP API endpoints |
| SIMD Performance | SIMD optimizations and benchmarks |
| Native HNSW | VelesDB's custom native HNSW implementation |
| Error Codes | Reference of VelesDB error codes |
| Known Limitations | Internal technical limitations of VelesDB Core |
Machine-readable contracts
| File | Description |
|---|---|
promise-contract.json | Verbatim-pinned claims (numbers/phrasings) checked against README.md and other docs by scripts/check-promise-contract.py. Not a doc to read — a gate contract; see the warning comment at the top of the root README.md. |