b894f1bbc5
The course's documents join the version contract. The course as kept and as served (wai.quantum.course/1) and each exercise (wai.quantum.exercise/1) move from course/schema/ to the crate's schemas/, named and versioned as the rest; a check, a lesson as served and a hint are wai.quantum.course-check/1, and a check now names its engine beside its schema; the command line's progress file is wai.quantum.learn-progress/1. The engine's test holds the course, every exercise, every lesson in each locale and a check and hint of some to them; the learn test holds the progress file; the contract workflow requires both, and the eval and lease tests, by name, and runs when the answer and eval sets its tests read change. The docs runner reads every page the branches added: the error-correction page, the version policy, the deprecations page, the service's self-hosting, scheduler and provenance pages, and the views' README. Each block the other branches wrote either runs or says why it cannot (a sweep fixture added), and the job service it starts keeps its store in its scratch. The crate's README names wai-quantum 0.7. The Chinese READMEs hold the English pages' code again: the sections for error correction, sets and sweeps, the service's dry runs, the scheduler, scoring a model, the answer layer, views and versions are translated, and the compile pages name the gate set basis. The command line's Chinese words cover task, qec, eval and version, and submit as it reads now. The documentation index links the policy, the deprecations, the error-correction page and the service's pages in both languages. The policy lists every schema file and says the answer layer is a draft outside its promise. The 0.7.0 heading names what the four branches bring. The views page bundles the Studio components that now read their words through the locale module; build-views.mjs gives it the English words alone, so no other language's words reach a host. The result parts the Studio and the views share read their words through it too, so the Studio's result pane stays translated, its English unchanged. Co-Authored-By: Claude Opus 5.5 <[email protected]>
88 lines
4.6 KiB
Markdown
88 lines
4.6 KiB
Markdown
# WAI Quantum documentation
|
|
|
|
Every command and code snippet on these pages runs in CI, and its output is
|
|
checked against the real output or its receipt (below). A page that cannot
|
|
run one says why.
|
|
|
|
## Start here
|
|
|
|
- **Learn:** [the circuits course](../course/README.md), from a first circuit
|
|
through superposition, entanglement, interference, the standard algorithms,
|
|
noise and its mitigation, error correction and fault tolerance to resource
|
|
estimates. Each exercise is checked by the engine. It runs in the Studio and
|
|
on the command line (`wai-quantum learn`), in English and in Simplified
|
|
Chinese. Beside it, *Quantum, reconsidered*, a seven-module course on
|
|
interference and learning, runs in the browser at
|
|
<https://wai.transaction.science/quantum-learn>.
|
|
- **The command line:** [`wai-quantum`](../../wai-quantum-cli/README.md):
|
|
run, check, draw, compile and estimate programs, verify receipts, and serve
|
|
the tools to agents.
|
|
- **In the browser and on the desktop:** [the Studio](../../quantum-studio/README.md)
|
|
and [the desktop app](../../wai-quantum-desktop/README.md).
|
|
- **From Python:** [`wai_quantum`](../../wai-quantum-py/README.md).
|
|
|
|
## The engine and its reference pages
|
|
|
|
- [The crate](../README.md): the simulator, the operational layer, the
|
|
research tools and the receipts.
|
|
- [Verdicts](verdicts.md): how far the engine checked an answer, the intents
|
|
and the repairs.
|
|
- [The compiler](compiler.md): the passes, the ε budget and the certificate.
|
|
- [Resource estimates](estimate.md): every number of an estimate and what it
|
|
assumes.
|
|
- [The reader's diagnostics](qasm-diagnostics.md) and
|
|
[what it does with each construct](qasm-feature-matrix.md).
|
|
- [The job layer's refusal codes](job-refusals.md).
|
|
- [Error correction and mitigation](qec.md): codes with their certified
|
|
distances, the decoders, thresholds, and mitigation in a job.
|
|
|
|
## Other surfaces
|
|
|
|
- [The job service](../../wai-quantum-service/README.md), over HTTP and MCP:
|
|
[running it yourself](../../wai-quantum-service/docs/self-host.md), as
|
|
[a batch scheduler's resource](../../wai-quantum-service/docs/scheduler.md),
|
|
and [what a result's provenance records](../../wai-quantum-service/docs/provenance.md).
|
|
- Views inside agent hosts: [the engine inside them](../../wai-quantum-views/README.md).
|
|
- The answer view layer, a draft extension: [its specification](../../extensions/quantum-answers.md).
|
|
- [Editors](../../tools/wai-quantum-editor/README.md): the language server,
|
|
the debugger and the formatter.
|
|
- [Your own hardware](../../wai-quantum-qpu/bring-your-own-quantum.md) and
|
|
[the provider crate](../../wai-quantum-qpu/README.md).
|
|
- [The workbench's specifications](../../wai-quantum-cli/discover/README.md).
|
|
- For agents: [the Agent Skill](../../wai-quantum-cli/skills/wai-quantum/SKILL.md)
|
|
and [`llms.txt`](../../wai-quantum-cli/docs/llms.txt), generated from the
|
|
servers' own tool lists.
|
|
|
|
## Changes between versions
|
|
|
|
- The changelog: [`wai/CHANGELOG.md`](../../CHANGELOG.md).
|
|
- What is stable, for how long, and how a change is announced, the schemas
|
|
of every document included: [the version policy](../VERSIONING.md).
|
|
- Each item deprecated, the version that deprecated it and its replacement:
|
|
[the deprecations page](../DEPRECATIONS.md).
|
|
|
|
## In other languages
|
|
|
|
Simplified Chinese: [this index](README.zh-CN.md), the
|
|
[command line's README](../../wai-quantum-cli/README.zh-CN.md), the
|
|
[Studio's](../../quantum-studio/README.zh-CN.md), the
|
|
[Python package's](../../wai-quantum-py/README.zh-CN.md), the
|
|
[crate's](../README.zh-CN.md), the course, the Studio's interface, and the
|
|
command line's own words (`--lang zh-CN`, or as `LANG` says). Each is a
|
|
machine-assisted translation, marked so, to be reviewed by a fluent reader.
|
|
|
|
## How these pages are checked
|
|
|
|
`wai/tools/quantum-docs/check_docs.py` reads every page named in its
|
|
`docs.json`. It runs each shell block marked `runnable` in a scratch
|
|
directory with the command line built from this checkout, runs the Python
|
|
blocks against the package and builds the Rust ones, and holds each shown
|
|
output to the real one. It verifies every receipt a block writes with
|
|
`wai-quantum verify`. A block that cannot run here (one that needs an
|
|
account, a server that does not return, or data the repository does not
|
|
hold) says so in its info string, and its commands must still name commands
|
|
and flags that exist. Every `wai-quantum …` in the prose must name a real
|
|
command, every relative link must reach a file, and every dependency a page
|
|
shows must be one this repository's version satisfies. A translation must
|
|
hold the same code as its English page. `.github/workflows/wai-quantum-docs.yml`
|
|
runs it, with the course's tests and the locale checks.
|