Download docs/README.md from Snapkitty/sovereign-engine-v2: direct link, hf CLI and curl.
- Browser
- Download file 2.14 kB
-
https://huggingface.co/Snapkitty/sovereign-engine-v2/resolve/main/docs/README.md
- Command line
-
hf download hf://Snapkitty/sovereign-engine-v2/docs/README.md
-
curl -L -o README.md https://huggingface.co/Snapkitty/sovereign-engine-v2/resolve/main/docs/README.md
Documentation
Start with Getting started for a local, provider-free example. All commands use the repository root unless a guide explicitly changes directories.
| Task | Guide |
|---|---|
| Set up Python and run the routing tests | Getting started |
| Understand subsystem boundaries | Architecture |
| Add asynchronous experts and inspect traces | Routing |
| Register and validate a tool | Tools |
| Choose actual configuration fields | Configuration |
| Inspect persistence and recovery interfaces | Continuity |
| Understand path checks, approvals, and evidence records | Security |
| Use the local provider adapter | Ollama |
| Inspect HTTP contracts and ASR sources | ASR and bridge |
| Build a desktop client | IDE |
| Run the stack VM and navigate native sources | Machine runtime |
| Run checks and interpret failures | Testing and troubleshooting |
| Review deployment gaps | Deployment readiness |
| Read the repository-sealing design | BRICK specification |
Evidence conventions
Examples marked local example use repository code and no external provider. The validation record identifies the examples actually executed. Provider examples require their service and credentials; they are interface examples unless a run is recorded.
The benchmark artifact records ten trials per strategy at source commit 898dfbe. Test passes, native builds, proof checks, and live provider results are separate evidence. There is no whole-repository production certification.
Research manuscripts remain under research/. Their hypotheses and specifications are not substitutes for runtime results. Obsolete sprint checklists and generated completion reports have been removed from the current documentation; their previous contents remain in Git history.