How it works

TrueCourse proves that a product does what its documentation promises. This page explains the words it uses and the background jobs that do the work.

The words

Word	Meaning
Workspace	Where documentation, repositories, members and the model provider belong.
Source	Where documents come from: a repository’s own markdown, or a documentation site through its llms.txt.
Document	One file or page a source yields.
Corpus	The documents a Document scan kept, grouped by area and split into sections.
Claim	A testable promise a section makes.
Flow	A journey through the product, built from claims.
Milestone	One claim of a flow, in order.
Case	A situation that would prove a milestone.
Test	What Flow generation writes for a flow, and what a Flow run executes.

The jobs

Every piece of work runs as a background job. It shows up on Agent as a conversation, and on Notifications once it settles.

Job	What it does	Calls a model
Source sync	Reads a source’s documents into the workspace.	No
Document scan	Curates the workspace’s documents into the corpus and finds conflicts.	Yes
Flow setup	Works out how to build, start and seed a repository, what it depends on, and which interfaces it offers.	Yes
Flow generation	Extracts claims, builds flows, and writes and proves the tests for each flow.	Yes
Flow run	Executes the tests against the program and stores the evidence.	No

How the work chains

You rarely start a job by hand. Each one starts the next:

Connecting a repository starts Flow setup

Flow setup reads the code, not the documents, so it runs even before any documentation is linked.

A source sync that changed something starts a Document scan

Sources sync when they are added, when you press Sync now, and on their own schedule. See Sources.

Flow setup starts Flow generation

It does so when the recipe held and the repository reads documents.

Flow generation starts a Flow run

It does so once it has stored tests. This first run is the repository’s baseline.

A scan that changed the corpus starts work for every repository it affects

When no conflict is open, each repository whose slice moved gets Flow setup if it was never set up, or Flow generation if it was.

To start a job yourself, use Run or Re-run on the repository’s Pipeline tab, or Scan on Context. Flow generation works on the repository’s default branch. Flow setup, Flow generation and Flow run run one at a time per workspace. Work waiting for its turn reads Queued and says what it waits for. Source syncs and the Document scan run beside them. Unlinking a repository cancels the work it has in flight.

Drivers

A test drives the program through one of its surfaces:

Driver	What it drives
CLI	The program’s command line.
API	The program’s HTTP service.
Web	The program’s web app, in a browser.

A flow that needs a TUI, library, desktop or mobile driver waits for one; those drivers do not exist yet. Flows can be filtered by driver.

Flow statuses

Every flow wears one of five statuses:

Status	Meaning
Succeeded	The flow’s tests passed, in the last run or when they were written.
Failed	A test ran and the product disagreed with the documentation.
Blocked	Something that can be provided is missing, such as an account for an external service, seed data, or a mapped code path. A flow whose test could not be written is Blocked too.
Not testable	There is nothing to test, or no code path does what the documentation promises. It is nobody’s to-do.
Never run	A test exists but has not executed yet.

Where to read results

Flows lists every flow of every repository. Filter by Status, Driver and Repository. Open a flow to see its milestones, their cases and its tests.
A repository’s Runs tab lists every Flow run, and each run opens with its evidence.
Home shows flows by status over time, what needs attention, and coverage by area.
Agent shows each job as a conversation, including why a job stopped.
Notifications keeps one row per job, from start to how it settled.

Getting Started

Workspace

Context

Code

Flows

Settings

Configuration

Enterprise

The words

The jobs

How the work chains

Drivers

Flow statuses

Where to read results

Next steps

Document scan

Flow setup

​The words

​The jobs

​How the work chains

​Drivers

​Flow statuses

​Where to read results

​Next steps

Document scan

Flow setup

The words

The jobs

How the work chains

Drivers

Flow statuses

Where to read results

Next steps