Quon’s documentation is organized by intent, not by a single linear
reading order. Pick the path that matches what you want to do today. Each path
states who it is for, the prerequisite knowledge it assumes, the outcome you
should reach, and the first readable or runnable page to open.
The five paths map to five distinct kinds of work:
Conceptual learning teaches the ideas. Recipes are complete, runnable programs.
Backend operations compile to a target and verify the result. Reference lookup
is the contract for extending the compiler. Contribution is improving the
codebase or docs. If you are unsure, start with the
First-time learner path — every other path assumes some
of what it teaches.
First-time learner
Learn typed quantum programming from first principles.
Prerequisite: none.
Outcome: read a circuit as a typed value Circuit<n, m, d, C> and a
qubit as a linear value, then compile the six-lesson track.
Start the learning track ->
Algorithm researcher
Run complete algorithms with verified resource bounds.
Prerequisite: quantum circuit basics; familiarity with Quon’s type
system.
Outcome: reproduce Aer-verified results for Bell, QFT, QAOA, and
Shor programs.
Open the cookbook ->
Backend / neutral-atom user
Compile to a fixed gate-model or reconfigurable neutral-atom target.
Prerequisite: Quon basics; domain knowledge of your target hardware.
Outcome: emit OpenQASM 3 or a neutral-atom schedule and resource
report, and verify on Aer.
Target a backend ->
Language author
Extend the language or build compiler tooling.
Prerequisite: Rust proficiency; basic compiler and MLIR knowledge.
Outcome: locate each pipeline stage and its invariant, and build the
LSP, formatter, and linter.
Read the architecture ->
Contributor
Improve the codebase or documentation.
Prerequisite: familiarity with Rust and the project guidelines.
Outcome: set up the Devbox environment and run the pre-PR gate
just test-ci.
Set up a checkout ->
You are new to quantum computing or to Quon and want to understand typed
quantum programming from first principles. This is the conceptual learning
path: it teaches the two load-bearing ideas — a circuit is a typed value and a
qubit is a linear value — before any algorithm.
Who it is for: readers who want to understand rather than run first.
Prerequisite: none.
Expected outcome: you can read a Circuit<n, m, d, C> type signature,
explain why a qubit is consumed exactly once, and compile a small .qn
program to OpenQASM 3.
The track is deliberately ordered and self-contained; each lesson links to the
next. When you finish, hand off to the Language guide
for the same material at reference depth, and to the cookbook for
complete runnable programs.
You want to implement algorithms and verify their resource bounds. This is the
recipes path: every page is a complete, CI-verified .qn program with its type
contract, optimized MLIR, and a seeded Aer assertion.
Who it is for: readers who learn by running real programs.
Prerequisite: quantum circuit basics, plus familiarity with Quon’s type
system from the Language guide or the learning
track above.
Expected outcome: you can reproduce a recipe’s Aer-checked result and
adapt its Circuit<n, m, d, C> contract to your own algorithm.
Next page:Cookbook, starting with the
Bell state — the smallest circuit that exercises the full
pipeline.
Recipes progress from a two-gate Bell pair through teleportation, phase
kickback, Grover, QFT, Ising, QAOA, and Shor’s quantum kernel, ending with the
neutral-atom QAOA schedule. Each page states what the typechecker proves before
a single gate is emitted.
You want to compile a program for a specific hardware target. This is the
backend operations path: fixed gate-model targets emit OpenQASM 3; neutral-atom
targets emit a movement schedule and a resource report.
Who it is for: readers targeting real or simulated hardware.
Prerequisite: Quon basics, plus domain knowledge of your target’s
connectivity, gate set, or neutral-atom geometry.
Expected outcome: you can pass a --target descriptor, emit the right
artifact, and run the OpenQASM path on Qiskit Aer.
The first-run setup and Aer verification workflows are tracked separately
rather than restated here, so the orientation cannot drift from the
implementation:
First-run validation and devbox run -- recovery live in
#373 — make the first
validation command recoverable outside a Devbox shell.
Aer bridge compiler discovery and the missing-dependency diagnostic live in
#375 — make Aer verification
discover local Quon builds and environments.
For the current, stable commands, see Install Quon
and Quickstart. The neutral-atom fault-tolerant
demo in NA FT demo walks the full NA path end to end.
You will extend the language or build compiler tooling — a new pass, a dialect
op, an editor integration. This is the reference lookup path: it points at the
stage that owns each invariant and the ADR that records why.
Who it is for: compiler and tooling developers.
Prerequisite: Rust proficiency; basic compiler and MLIR knowledge.
Expected outcome: you can locate the module responsible for a pipeline
stage, read its ADR, and build the LSP, formatter, and linter from source.
The contributor first-run recovery path — making just discoverable outside a
Devbox shell — is tracked in
#373. Agent-facing validation
and code-quality rules live in the
validation guide
and
code-quality guide.