Skip to main content
Detail integrates with GitHub through a GitHub App that you install on your personal account or organization. The app grants Detail read access to scan your repositories and write access to open pull requests for doc fixes or dead code.

​
Installing the GitHub App

1

Sign in with GitHub

Go to app.detail.dev and sign in using GitHub OAuth.
2

Install the Detail GitHub App

After signing in, you’ll be prompted to install the Detail GitHub App on your account or organization. Click Install.
3

Select repositories

Choose which repositories you want Detail to access. You can start with a single repository and expand later — you don’t need to grant access to everything upfront.
4

Authorize the app

Complete the GitHub authorization flow. You’ll be redirected back to the Detail dashboard once the app is installed successfully.

​
Permissions Detail requests

Detail requests the minimum permissions needed to scan your code and open fix PRs.

​
Adding or removing repositories

You can adjust which repositories Detail can access at any time through two paths:
  • Via GitHub: Go to GitHub → Settings → Applications → Detail and modify the repository list under Repository access.
  • Via Detail: Go to Settings → Repositories in the Detail dashboard, then click Add Repository or Remove from Detail.

​
GitHub Enterprise Server

Detail supports GitHub Enterprise Server (GHE) for teams on self-hosted GitHub installations. Because GHE requires a custom GitHub App registration against your own hostname, this is handled on a per-organization basis. Contact the Detail team at [email protected] to configure a custom GitHub App for your GHE instance.

​
How automated pull requests work

When Detail’s Dead Code or Doc Drift scans find problems, they open a pull request in your GitHub repository. The PR includes a description of what was changed and why. If CI checks fail on a Detail-created PR, Detail will update the branch automatically.
Detail never pushes directly to your main or default branch. Every change goes through a pull request that you can review, request changes on, or close.