Short Answer: Open 'Generate documentation', choose a connection method and click 'Connect GitHub' to authorize access to your repositories.
Prerequisites
-
A GitHub account
-
Access to the repository you want to document
-
Organization owner or admin access to install the GitHub App (Recommended) (if using 'GitHub App (Recommended)')
Steps
-
Open the Generate documentation page.
You see the 'Generate documentation' panel with 'Connect to GitHub' options. -
Under 'Connect to GitHub' select 'GitHub App (Recommended)' or 'GitHub OAuth'.
Your chosen method is highlighted. -
Click 'Connect GitHub'.
A GitHub authorization window or redirect opens. -
Complete the GitHub authorization (accept the requested permissions).
GitHub account is connected and you return to 'Choose repository and branch'. -
Select 'GitHub account', 'Repository' and 'Branch', then click 'Continue'.
You move to the 'Select files to document' step.
Troubleshooting
-
'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. -
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.