Examples and Evidence Index

This index explains what each TeaQL example can actually prove. A code block, model description, generated workspace, executed test, and retained CI artifact are different evidence classes and must not be presented as interchangeable.

Inventory last reviewed: 2026-07-14.

Evidence Classes

Class	Meaning
Reproducible fixture	Inputs and repeatable commands are committed; execution still needs a recorded run.
Executed	A named version combination was run successfully on a recorded date.
Retained CI evidence	Logs, manifests, outputs, and a run/artifact identifier are preserved.
Contract-checked illustration	Static code shape passes documentation rules but was not compiled against a generated model.
Historical evaluation	Evidence for an older version; useful for history, not current compatibility.

“Runnable” should identify the exact command, working directory, dependency versions, provider, expected result, and retained evidence. Without those fields, use a narrower status.

Current Example Inventory

Example	Location	Current status	What it proves	What it does not prove
Minimal Golden Path model	model.xml and fixture POM	Reproducible committed input	One SQLite model and Maven plugin fixture are available to evaluation/generation jobs.	A committed generated workspace or successful runtime by themselves.
Golden Path workflow	golden-path.yml	Workflow defined; no retained remote run recorded	Exact Java/Rust client, target, generation, test, classification, and artifact-retention procedure.	Retained CI proof until a run/artifact ID is added to the evidence ledger.
Rust Quick Start	Quick Start — Rust	Executed locally on 2026-07-13	cargo-teaql 2.0.8, both dynamic targets, TeaQL/SQLite 4.1.1, tests, startup, query, audited mutation, and regeneration.	MSRV, non-SQLite providers, load/concurrency limits, or release support lifetime.
Java Golden Path	Verification Evidence	Evaluation/generation/regeneration executed; build blocked	Maven plugin 1.1.0 target discovery and Java generation behavior, including current defects.	A runnable Java application, query, or mutation.
Model Explorer source catalog	src/data/models.js and ModelExplorer	Contract-checked illustration; src/pages/models/** is currently excluded from the site build	Five domain guides, each with six Java/Rust scenario pairs, follow documented intent/audit terminal shapes.	A currently published route, source KSML, successful generation, compilation, provider execution, or exact emitted methods for those models.
Cookbook	Cookbook evidence matrix	Mixed per recipe	Each recipe declares its source/runtime review or executed boundary and missing tests.	Uniform execution status across every recipe or stack.
Evaluation Report #001	PDF report	Historical evaluation dated 2026-06-09	A school-management Rust exercise reported for TeaQL 3.2.2, SQLite/SQLx 0.8, and cargo-teaql 0.2.0.	Current TeaQL 4.1.1, current provider architecture, or current client 2.0.8 compatibility.

The PDF is retained as historical engineering evidence. Its commands, crate names, generated shapes, and conclusions must not be copied into current setup guidance without regeneration and verification.

Model Explorer Source Boundary

The Model Explorer source currently contains five catalog entries:

• Ecommerce Order Service;
• Clinic Appointment Service;
• Hotel Management Service;
• Helpdesk Ticketing Service;
• Supply Chain Service.

Each entry contains six scenarios—simple query, graph loading, advanced filter, aggregation, DDD extension, and runtime customization—with both Java and Rust variants. That is 30 scenario pairs and 60 language-specific snippets.

The documentation contract checker validates query intent ordering and mutation audit terminals in those strings. The model data file does not contain the KSML sources named by its sourceDir labels, and those scenarios have not been generated or compiled as current workspaces. Treat every generated facade, entity, relation, filter, and update method as illustrative until the matching model source and generated evidence are committed.

The Docusaurus pages configuration currently excludes models/**, so these components do not constitute a published model catalog. Removing that exclusion is a separate publication decision and should happen only after the evidence and navigation requirements below are satisfied.

Reproduce the Maintained Path

For the current Rust path, follow the complete Rust Quick Start. For the committed CI fixture, inspect the live target catalog first and then use the commands in the Golden Path workflow.

For Java, stop after preserving the current build failures. Do not repair the generated POM or dispatch methods in committed generated output. The current blockers are recorded in Java Compatibility.

Evidence Still Missing

The example collection is not ready for a first-class top-level Examples section until it includes:

1. a clean current Java generated build, query, audited mutation, and retained logs;
2. a retained run/artifact identifier for the committed Golden Path workflow;
3. at least one maintained generated-output sample with its source model and generator command;
4. compiled/generated evidence for Model Explorer entries or an explicit decision to keep them as design-only guides;
5. current non-SQLite provider examples with provider/database/toolchain versions and expected output;
6. small AI task examples with allowed edit surfaces and generated-output review checklists.

Adding or Promoting an Example

An example entry must record:

• source model or fixture path;
• client and generator versions;
• dynamic target and exact command;
• generated dependency versions;
• build/test/run command and working directory;
• provider/database/toolchain versions;
• expected output;
• generated versus handwritten file boundaries;
• evidence status, date, owner, update trigger, and retained artifact link.

Promote an illustration to executed only after its exact model and methods are generated and run. Promote an executed example to retained CI evidence only after logs/artifacts have a durable run identifier.