Skip to content

Repository Handbook

This handbook explains the logic of the split. It is the place to answer questions that no single package can answer honestly on its own: why the family exists as multiple packages, which decisions belong above package boundaries, and where repository authority must stop before it starts flattening the product into one vague story.

The important discipline here is restraint. A repository root should make the whole system legible, then hand the reader to the true owner. If it keeps talking after that point, it becomes noise.

flowchart TB
    root["repository handbook<br/>system split and cross-package logic"]
    foundation["foundation<br/>shared meaning"]
    core["core<br/>durable program rules"]
    knowledge["knowledge<br/>evidence state"]
    intelligence["intelligence<br/>decision policy"]
    lab["lab<br/>assay loop"]
    runtime["runtime<br/>execution control"]
    maintain["maintainer handbook<br/>repository health"]

    root --> foundation
    root --> core
    root --> knowledge
    root --> intelligence
    root --> lab
    root --> runtime
    root --> maintain

What This Handbook Does Well

  • it shows why the system is layered instead of monolithic
  • it names the seams between meaning, rules, evidence, judgment, execution, and lab action
  • it keeps the reader from blaming the wrong package for the wrong kind of change

Start With

  • Open Foundation when the question is why the split exists and where authority changes hands.
  • Open Scientific Workflow Roadmap when the question is which scientific workflow capabilities still need to be made explicit across package boundaries.
  • Open Operations when the question is how the repository validates, releases, and reviews work across package boundaries.
  • Open the Maintainer Handbook when the answer lives in helper code, make routing, or GitHub automation.

Questions This Handbook Owns

  • Why is one concern a package boundary while another is only a module?
  • Which package should own a disputed behavior?
  • Which repository surfaces are truly shared and which are only adjacent?

Product Handbooks

First Proof Check

  • packages/ for the package seams this handbook is describing
  • Makefile and makes/ for root-owned command and release routing
  • apis/ and .github/workflows/ for repository-level contract and validation surfaces

Boundary Test

If the best proof lives mostly in one package source tree, one package test suite, or one package API contract, the root should hand the reader off instead of pretending repository prose owns that behavior.