Home CodeDoc How do I connect my GitHub account to Generate documentation?

How do I connect my GitHub account to Generate documentation?

Last updated on Nov 10, 2025

Short Answer: Open 'Generate documentation', choose a connection method and click 'Connect GitHub' to authorize access to your repositories.

Prerequisites

  1. A GitHub account

  2. Access to the repository you want to document

  3. Organization owner or admin access to install the GitHub App (Recommended) (if using 'GitHub App (Recommended)')

Steps

  1. Open the Generate documentation page.
    You see the 'Generate documentation' panel with 'Connect to GitHub' options.

  2. Under 'Connect to GitHub' select 'GitHub App (Recommended)' or 'GitHub OAuth'.
    Your chosen method is highlighted.

  3. Click 'Connect GitHub'.
    A GitHub authorization window or redirect opens.

  4. Complete the GitHub authorization (accept the requested permissions).
    GitHub account is connected and you return to 'Choose repository and branch'.

  5. Select 'GitHub account', 'Repository' and 'Branch', then click 'Continue'.
    You move to the 'Select files to document' step.

Troubleshooting

  1. 'GitHub account' or repositories do not appear in the dropdown.
    LikelyCause: GitHub authorization was not completed or you signed in to a different GitHub account.
    Action: Click 'Connect GitHub' again and complete the authorization using the intended GitHub account.

  2. You can't install the GitHub App (organization install blocked).
    LikelyCause: You are not an organization owner or admin required to install the app to an org.
    Action: Use 'GitHub OAuth' for repo-level access or ask an org owner/admin to install 'GitHub App (Recommended)'.

Note: Use 'GitHub App (Recommended)' for org installations and 'GitHub OAuth' for personal or repo-level access.