Reviewing Branch Changes
When code is pushed to your connected repository, Hyperdocs detects the new commits and helps you keep your documentation up to date. You can review what changed, generate fresh draft documentation, and decide whether to accept or reject the incoming updates.
How It Works
•Hyperdocs watches your connected repository and notifies you in real time when new changes are pushed to the tracked branch.
•Pending commits are listed so you can see exactly what has changed since your last sync.
•Only commits that affect documentation are flagged as ready to generate docs, while non-relevant commits are acknowledged automatically.
•Generation jobs draft updated documentation from your code, with live progress shown as the job runs.
•You review the proposed changes and choose to accept them into your docs or reject them to keep your existing content.
Steps
1.Open the Git Sync area from the admin dashboard to view your connected repository and its tracked branch.
2.Select Check for updates to fetch the latest commits. Hyperdocs shows how many pending commits were found, or confirms your codebase is already up to date.
3.Review the list of pending commits, including their messages and dates, to understand what changed in the repository.
4.Choose Generate docs to queue a generation job that drafts updated documentation from the relevant commits, and watch its progress.
5.When the draft is ready, review the proposed changes for each affected page.
6.Accept the changes to apply them to your docs, or reject them to keep your current content unchanged.
Change Review Actions
Action | What It Does |
|---|---|
Check for updates | Fetches the latest commits from your connected branch and reports how many are pending. |
Generate docs | Queues a job that drafts updated documentation from the relevant commits. |
Accept changes | Applies the proposed updates to the affected documentation pages. |
Reject changes | Discards the proposed updates and keeps your existing content as it is. |
Tips
•Check for updates regularly so your published docs stay aligned with the latest code in your repository.
•Always review the proposed changes carefully before accepting, especially for pages you have manually edited.
•Generation jobs use your plan's documentation generation credits, so keep an eye on your remaining balance.
Commits that don't affect documentation are acknowledged automatically, so you only review changes that actually matter for your docs.
If you reach your plan's generation limit, you'll be prompted to upgrade before you can draft new documentation or continue using Git Sync.
Troubleshooting
•If no commits appear, confirm your GitHub account is connected and that a repository is linked to your project.
•If checking for updates shows your codebase is up to date, there are no new commits since your last sync — push new changes to trigger updates.
•If a generation job fails to start, you may have reached your plan limit; review your remaining generation credits and upgrade if needed.
•If real-time notifications stop appearing, refresh the page and run Check for updates manually to re-sync your repository status.
Related topics: Connect GitHub Repository, Sync and Generate Docs from Code, Track Generation Credits.