Skip to content

tiny-corpus-workbench

Learn document preparation by doing it

Learn how a raw document becomes an inspectable prepared revision for later corpus use. Read the principle first. Then use the Local Visual Workbench to test the same idea on a real local record.

Document preparation happens before a later system searches, ranks, or generates from a corpus. Those downstream tasks are useful, but they are not this project's subject. This course asks an earlier question: what document do we have, how did we prepare it, and what evidence explains that work?

The course stops at a prepared document revision. It does not teach chunking, embeddings, indexing, retrieval, generation, or RAG evaluation.

Start with one lifecycle

text
raw source
  -> captured source and extraction views
  -> canonical DoclingDocument
  -> evidence-based diagnosis
  -> explicit human decision
  -> immutable prepared revision
  -> explicit corpus inspection

The CLI and the Workbench are two interfaces over the same local lifecycle. The CLI is the complete, precise interface. The Workbench is the practice table. It helps you see what each stage means before you inspect detailed records. Neither interface creates a second lifecycle.

The questions behind the stages

Each stage answers one different question. Keep the questions separate.

StageQuestionMain resultIt does not do this
ObserveWhat did we receive and extract?A captured source, extraction views, and a canonical document when usable.Diagnose or change the document.
DiagnoseWhich fixed conditions match?Findings with rule-specific evidence.Decide that a change is allowed.
RefineWhat supported change is possible, and do we accept it?A proposal, then one explicit human decision.Quietly edit a document.
RevisionWhat did an approved decision create?One immutable successor and its history.Replace the original document.
Inspect a corpusWhat patterns exist across declared members?Aggregate, source-text-free evidence.Discover files or modify members.

Two ideas hold the course together:

  • Evidence says what the application observed or calculated.
  • Authority says whether a person chose to apply a supported change.

The application can produce useful evidence without changing anything. A person can reject a proposal without losing that evidence. This distinction is why the lifecycle remains understandable after several runs.

Learning path

Before you begin

These lessons assume that the repository is already installed in an active Python virtual environment. Confirm that corpus --help works, then begin with the first lesson. The first four Workbench exercises use project-authored Markdown fixtures and do not need PDF models.

Use a separate temporary workspace for practice when you want to start again:

bash
LESSON_WORKSPACE="$(mktemp -d)"
corpus workbench --workspace "$LESSON_WORKSPACE" --no-open

The command prints a local address. Open it in a browser. Press Ctrl-C in the terminal when you finish. The first lesson starts with the ideas you need before you run any lifecycle action.