Generating Docs from Code
Hyperdocs can draft documentation directly from your connected GitHub repository. By checking for new commits and running a generation job, you can keep your docs in sync with your codebase without writing every page from scratch.
How It Works
•Hyperdocs reads the commit history of your connected repository and identifies which changes are relevant for documentation.
•A pending commit count shows you how many new updates are waiting to be drafted into docs.
•Triggering a generation job queues the work and drafts new documentation pages based on your code changes.
•You can watch live job progress and status messages as the documentation is being generated.
•Commits that aren't relevant for documentation are automatically acknowledged so they don't clutter your pending updates.
Steps
1.Open the Git Sync page from your admin dashboard. Make sure your GitHub account and repository are already connected.
2.Click the check or refresh option to look for new commits. Hyperdocs scans your repository's default branch for the latest changes.
3.Review the pending commit count and the list of commits to see what has changed since your last sync.
4.Click Generate to queue a documentation generation job. The job is added to the queue and begins drafting docs.
5.Watch the progress bar and status messages until the job completes, then review the newly drafted pages in your editor.
Sync Status Indicators
Indicator | What It Means |
|---|---|
Pending commits found | New code changes are ready to be drafted into documentation. |
No new updates | Your codebase is already up to date with your docs. |
Job queued | Your generation job has been accepted and is waiting to start. |
In progress | Documentation is actively being drafted; a progress percentage is shown. |
Completed | The drafted docs are ready for you to review and refine. |
Tips
•Check for new commits regularly so your documentation stays aligned with your latest code.
•Treat generated pages as drafts — review and edit them in the block editor before publishing to your live site.
•Keep an eye on your generation credits, since each job draws from your plan's allowance.
Generation jobs run in the background — you can leave the page and return to check progress later.
If you reach your plan limit, generation will stop and you'll be prompted to upgrade to continue drafting documents.
Troubleshooting
•No repository to check: confirm your GitHub account is connected and a repository has been linked to your project.
•Generation won't start: if you see an upgrade message, your plan's credits may be exhausted — upgrade to continue using doc generation.
•Commit history fails to load: try refreshing the sync status; a temporary connection issue may have interrupted the check.
•Commits don't appear as pending: changes that aren't relevant for documentation are acknowledged automatically and won't show as updates.
Related topics: Connect GitHub Repository, Review Incoming Branch Changes, Track Generation Credits.