Link your code
Docmunk reads your app’s code through a GitHub App, so it can find the articles a change makes wrong.
Before you start
- You’re an owner or admin.
- Your GitHub account can install apps on the account or organization that owns the repository, and can read every repository you give the app.
1. Install the GitHub App
On Setup, under Link your code, select Install the GitHub App. On GitHub, pick the account that owns the repository, choose the repositories the app can read, and install it. GitHub sends you back to Setup with “GitHub is connected. Pick the repository.”
If your organization installed the app before, go to step 2.
2. Pick the repository
Under Repository, pick it from Pick one…, then select Link and clone. Docmunk copies the repository; Setup shows “Cloning” and the repository’s name until the copy is done.
Docmunk then checks your code once a day. To check on every push, or only when you ask, see Choose when Docmunk checks your code.
Not ready? Select Skip for now, and link it later on Product › Code.
If GitHub or the copy fails
- “Only an owner or admin can connect GitHub.” See Cannot connect GitHub as a member.
- “Connect with a GitHub account that can read every repository you gave the App.” Install the app again with an account that can read every repository you chose, or choose fewer.
- “GitHub did not finish. Try again.” Select Install the GitHub App again.
- Setup says the repository “could not be cloned.” Select Try again.