documentalist

type Budgets struct {
	DocLines     int `json:"doc-lines"`
	SectionWords int `json:"section-words"`
	CardWords    struct {
		Min int `json:"min"`
		Max int `json:"max"`
	} `json:"card-words"`
	FolderLines        int `json:"folder-lines"`
	RootAgentFileLines int `json:"root-agent-file-lines"`
}

type Doc struct {
	Path    string
	Sources []string
	Checked map[string]string // repository name ("" = this one) -> commit
	// JudgedInParts is the commit the doc was last judged in parts at: it is
	// not put before an agent again until a source changes after it.
	JudgedInParts string
	// Judged is the commit an agent judged the doc whole at without vouching
	// for every sentence: held the same way.
	Judged string
}

type Duplicates struct {
	MinWords   int     `json:"min-words"`
	Similarity float64 `json:"similarity"`
}

type Freshness struct {
	StaleAfterDays int `json:"stale-after-days"`
}

type Problem struct {
	Rule, Where, Message, Key string
	Size                      int
	Other                     string // a duplicate: the other doc holding the passage
}

type Reader struct {
	// Pages: the user pages, among the docs the role reads; Skip: those left
	// out (specs). Records — decisions, research, history — are always left
	// out: they are read for what was true then, not as a guide.
	Pages []string `json:"pages"`
	Skip  []string `json:"skip"`
	// Navigation: the pages a reader starts from; every user page must be
	// reached from one, link after link through user pages.
	Navigation []string `json:"navigation"`
	// Flow: pages that explain a flow and need a diagram, beside any page
	// with a heading holding one of FlowHeadings (as words, any case): a
	// project writes them in its own language.
	Flow           []string `json:"flow"`
	FlowHeadings   []string `json:"flow-headings"`
	ParagraphWords int      `json:"paragraph-words"`
	CellWords      int      `json:"cell-words"`
}

type Ref string

type SampleSettings struct {
	Judge   string `json:"judge"`    // an --ai value: claude:opus, cmd:…
	AtLeast string `json:"at-least"` // provider, model or context (ADR-0005)
	// After: a commit (a tag) before which nothing is sampled — the
	// release whose engine earns `checked` (ADR-0014, step 0).
	After Ref `json:"after"`
}

type Settings struct {
	Docs        []string `json:"docs"`
	Propagation []struct {
		From string `json:"from"`
		To   string `json:"to"`
		When string `json:"when"`
	} `json:"propagation"`
	Budgets    Budgets    `json:"budgets"`
	Duplicates Duplicates `json:"duplicates"`
	Freshness  Freshness  `json:"freshness"`
	Reader     Reader     `json:"reader"`
	// MaxOpenMergeRequests stops gardening while this many of the role's
	// merge requests wait for review (ADR-0006).
	MaxOpenMergeRequests int `json:"max-open-merge-requests"`
	Truth                struct {
		Doc []string `json:"doc"` // docs the code follows: never rewritten to match it
	} `json:"truth"`
	AIMaxCalls int               `json:"ai-max-calls"`
	Derive     map[string]string `json:"derive"` // name -> command giving a derived block
	// Documented: the code the project wants described; a file of it no
	// doc names in its sources is reported.
	Documented []string `json:"documented"`
	// JudgeInParts judges a doc whose sources do not fit a task in parts,
	// instead of leaving it to a person (ADR-0009); PartsMax caps the parts
	// of one doc, PartsMaxPerRun those asked in one run.
	JudgeInParts   bool `json:"judge-in-parts"`
	PartsMax       int  `json:"parts-max"`
	PartsMaxPerRun int  `json:"parts-max-per-run"`
	// For measuring whole against parts on the same doc (tests/evaluation):
	// PartsAlways judges in parts even a doc that fits whole, PartChars
	// caps the sources' share of a part, so that small sources still split.
	PartsAlways bool `json:"parts-always"`
	PartChars   int  `json:"part-chars"`
	// History and Decisions: the project's globs of history docs and of
	// decision records, added to the names the usual tools give them
	// (records.go).
	History   []string `json:"history"`
	Decisions []string `json:"decisions"`
	// Language: the docs' language, whose glue and fact words the removal
	// rule reads ("en", "fr"); "" reads each doc's own (words.go).
	Language string `json:"language"`
	// Versions: how the project writes a version, when not in three parts
	// (a regexp), and the files saying its version (values.go).
	Versions struct {
		Pattern string   `json:"pattern"`
		Files   []string `json:"files"`
	} `json:"versions"`
	// WholeChars caps the characters a doc's sources may take to be judged
	// whole; past it, a person judges the doc, or it is judged in parts.
	WholeChars int `json:"whole-chars"`
	// Sample: who reads the weekly sample of the docs vouched for
	// (ADR-0014, step 4; workline sample).
	Sample SampleSettings `json:"sample"`
}

type Tree struct {
	Docs  map[string]string
	Files map[string]bool
}