Run

One end-to-end documentation update cycle. Created when a trigger fires, it tracks progress through pending, running, success, and failed states and stores all generated output.

Agent

A specialised AI worker responsible for one doc type. Pith ships four agents: README, API reference, architecture, and changelog. Each one reads the diff and your template to produce updated content.

Template

A Markdown document that defines the structure, tone, and scope of a generated doc artifact. Templates are org-scoped and assignable to multiple repositories.

Watch branch

The branch that Pith monitors for events. Only pull requests targeting (or merged into) this branch trigger runs. Defaults to the repository's default branch.

Trigger

The event that kicks off a run: PR approved, PR merged, CI API call, or manual.

DocRun

The internal name for a run record. Stores the commit SHAs, trigger type, status, progress log, and output artifacts.

DocOutput

A single generated file produced by a run - for example the updated README.md. Each run can produce one output per enabled doc type.

Queued run

A run that could not be executed immediately because the monthly quota was exceeded. It is stored and retried automatically when capacity is available.

.pith.yml

The configuration file for Pith. Controls which doc types are enabled, output paths, templates, and output mode. Used by both the CLI and SaaS dashboard.