Repository map¶
This is what GitHub visitors see and where the rest lives.
| Path | What it is |
|---|---|
| README.md | Landing page: why VectorSmith exists, YAML sketch, two consumption paths |
| docs/ | Full manual (this tree). Start at library surface for extras / routes / exceptions |
| docs/conformance.md | Live backend versions, contract coverage, skips, and stability gates |
| examples/ | Invoice + ticket YAML, enterprise JWT/tenancy/RBAC, agent apps, MCP host configs |
| packages/core | Compiler source (vectorsmith_core) — bundled into the published wheel, not a PyPI project |
| packages/cli | Published vectorsmith — CLI + load_tools / connect |
| tests/conformance | Deterministic six-backend live contract, seed fixtures, and independent oracle |
| deploy-templates/ | Docker / Kubernetes / Cloud Run / Fly for HTTP MCP |
| CONTRIBUTING.md | Dev setup, PR rules, versioning |
| SUPPORT.md | Where to ask for help |
| SECURITY.md | Vulnerability reports (private) |
| CHANGELOG.md | User-visible changes |
| LICENSE · NOTICE | Apache-2.0 |
Do not import Engine. Application code uses from vectorsmith import load_tools or connect, or the vectorsmith CLI.
Current support evidence and the rules for promoting an adapter are documented
under backend conformance. Local evidence and product-research
notes under .internal/ are deliberately not published.