Skip to content

Choose your path

Use this page when you know your goal but not which document to open. The site is organized by outcomes—not by Rust module names or segment types.

I am evaluating ModelVault

You need a clear answer to what problem this solves and what it does not try to be.

Question Document
Why does ModelVault exist? Why ModelVault
How is it different from SQLite, JSON, TinyDB, DuckDB? Comparisons
Can I try it in five minutes? Quickstart
What does the project guarantee? Compatibility · Types · Security
What is planned next? Roadmap on GitHub
Narrative overview Launch essay

Start on the home page for the same positioning summary as the GitHub README.

I am building an application

You have chosen ModelVault (or are close) and need the right tutorial.

I use… Start here
Pydantic Pydantic guide → Models & collections
FastAPI FastAPI guide (AsyncDatabase, async def) → Python guide
Python (general) Quickstart → Python guide
Rust Quickstart → Rust API

Then deepen your understanding:

I am operating in production

You run ModelVault in shipped software and need runbooks, not tutorials.

Task Document
Backup and restore Operations runbook
Inspect or verify a file CLI reference
Crash or corruption recovery Compatibility
Tracing and diagnostics Debugging

I am contributing or extending the engine

You work on the repository or need file-format contracts.

Task Document
Dev setup and CI Contributing
Documentation conventions Documentation map
On-disk layout and specs Specifications
Release checklist Readiness

Terminology

Short definitions: Glossary.