Connecting a GitHub Repository
Connecting a GitHub repository lets Hyperdocs automatically draft documentation from your code. By authorizing GitHub and linking a repository, you can keep your docs in sync with your codebase and generate updated pages whenever new commits are pushed.
How It Works
•Authorize Hyperdocs to access your GitHub account using a secure OAuth sign-in flow.
•Choose a repository from your GitHub account and link it to your docs project.
•Hyperdocs reads the repository's default branch and checks for pending commits.
•Once connected, you can trigger documentation generation jobs that draft docs from code changes.
•Your connection status and linked GitHub username are shown so you always know what's linked.
Steps
1.Open your Hyperdocs admin dashboard and go to the Git Sync section.
2.Select the option to connect your GitHub account. You'll be redirected to GitHub to authorize access.
3.Approve the authorization on GitHub. After approval, you're returned to Hyperdocs and your GitHub username appears as connected.\
4.Choose the repository you want to link from your available repositories.
5.Hyperdocs loads the default branch and checks for any pending commits ready for documentation.
6.Select Generate to draft documentation from the connected repository's changes.
Connection Status Indicators
Status | What It Means |
|---|---|
Connected | Your GitHub account is authorized and your username is displayed. |
Not connected | No GitHub account is linked yet; you'll be prompted to connect. |
Pending commits found | New commits are available and ready for documentation generation. |
Up to date | No new updates are available; your codebase matches your docs. |
Tips
•Use the check-for-updates action to confirm how many pending commits are waiting before you generate docs.
•Commits that don't contain documentation-relevant changes are automatically acknowledged so they won't clutter your pending list.
Documentation generation uses your plan's generation credits. If you reach your limit, you'll be prompted to upgrade to continue.
After connecting, return to the Git Sync section anytime to re-check commits and run a fresh generation job.
Troubleshooting
•If no repositories appear after connecting, confirm you authorized access to the correct GitHub account and that it has repositories available.
•If your account shows as not connected, restart the authorization flow from the Git Sync section and approve all requested permissions.
•If checking for commits fails, retry the check; a temporary connection issue can prevent commit history from loading.
•If documentation generation won't start and shows an upgrade message, you've reached your generation credit limit and need to upgrade your plan.
Related topics: Sync and Generate Docs from Code, Review Incoming Branch Changes, Track Generation Credits.