Configuration
Per-repository and organisation-level settings in the SaaS dashboard.
.pith.yml. See the CLI section.Doc types
For each repository you can independently enable or disable each of the four doc types, set the output file path, and assign a template.
| Setting | Description |
|---|---|
| Enabled | Whether this doc type runs on each trigger |
| Output path | Repository-relative path where the file is written (e.g. docs/api.md) |
| Template | Which template the agent uses to generate content |
Watch branch
The watch branch is the branch that triggers documentation runs. It defaults to the repository's default branch (main or master). Only events targeting this branch are processed. Change it in Dashboard - [repo] - Config.
Trigger mode
| Mode | When it fires |
|---|---|
| PR approved | When a pull request / merge request targeting the watch branch is approved |
| PR merged | When a pull request / merge request is merged into the watch branch |
| Manual only | Only when you click "Run now" in the dashboard or call the API trigger |
Organisation defaults
Default doc type settings and trigger mode apply to every new repository you connect. Configure them under Dashboard - Settings - Defaults so you don't have to reconfigure each repo from scratch.
Notion integration
Connect your Notion workspace under Settings - Integrations. Once connected, each doc type can be assigned a destination Notion page. Pith will sync the generated Markdown to that page after every successful run in addition to opening the GitHub / GitLab PR.
Ready to stop writing docs by hand?
Connect your first repository and Pith will handle the rest.