GitHub App
The recommended integration for GitHub-hosted repositories.
Pith uses a GitHub App rather than a personal access token. This means the integration is tied to your organisation (not a personal account), permissions are scoped precisely, and tokens rotate automatically.
Installation
- 1
Install the app
Go to Dashboard - Settings - Integrations and click Install GitHub App. You will be redirected to GitHub to select which repositories to grant access to. You can grant access to all repositories in an organisation or pick specific ones. - 2
Repository sync
After installation, Pith immediately syncs all accessible repositories. They appear under your dashboard within seconds. - 3
Configure each repo
Open a repository in the dashboard, enable the doc types you want, and set the watch branch. Pith will start generating docs on the next qualifying event.
Permissions requested
| Permission | Level | Why |
|---|---|---|
| Contents | Read | Read source files and existing documentation |
| Pull requests | Read/Write | Open documentation PRs and post progress comments |
| Metadata | Read | List repositories and branches |
Trigger
By default Pith fires when a pull request targeting your watch branch is approved. This lets docs generate while the PR is still open so the documentation PR can be reviewed alongside the code change.
You can change the trigger to PR merged or manual only in the repository configuration panel.
PR comments
Pith posts a comment to the source PR when a run starts and links to the generated documentation PR when the run completes. On first run it notes that generation may take a few extra seconds as the model builds context for your repository.
Ready to stop writing docs by hand?
Connect your first repository and Pith will handle the rest.