FlagQuantum Documentation
September 11, 2026 · View on GitHub
FlagQuantum documentation is organized by purpose so that users, contributors, and maintainers can find the right level of detail quickly.
Start here
-
Publication validation scope — tested workflows, evidence boundaries, and research goals
-
API reference — public Python interfaces and examples
-
Runtime architecture — execution model, planning, and distributed semantics
-
Runtime configuration — backend and environment controls
-
Known limitations — current support boundaries
-
Testing manual — verification tiers and commands
-
Product roadmap — planned user-facing capabilities
Documentation map
| Area | Purpose |
|---|---|
| Concepts | Product-wide principles and scalability semantics |
| Architecture | Runtime, parallelism, state, and subsystem design |
| Reference | Public APIs, contracts, policies, and support matrices |
| Guides | Operational runbooks and performance case studies |
| Development | Repository, testing, dependency, and release workflows |
| Roadmap | Vision, maturity, ecosystem, and delivery plans |
| Generated | Machine-generated capability and stable-API inventories |
Machine-readable capability contracts live in the repository-level
contracts/ directory. Repository-wide architecture,
capability-maturity, and dependency policies remain at the repository root.
These files are inputs to repository tooling rather than manually curated
guides.
For runnable workflows, continue to the examples index. For benchmark methodology and evidence, use the benchmark index. Repository retention and evidence-placement rules are defined in repository governance.