For LLMs and AI agents: see llms.txt for the documentation index, or llms-full.txt for the full text. A Markdown version of any page is available by appending .md to its URL.
Generation credits power Hyperdocs' ability to automatically draft documentation from your connected repository. Tracking your remaining credits helps you understand how much auto-generation capacity you have left on your current plan and lets you upgrade before you hit a limit.
How It Works
•Each time you run a documentation generation job from your connected GitHub repository, it draws from your plan's available credits.
•Your remaining credits are tracked against your plan, so you always know how much auto-generation capacity is left.
•When a generation job reaches your plan's limit, Hyperdocs stops the job and prompts you to upgrade.
•You'll see a clear notification if you try to draft documents or continue using Git sync without enough remaining credits.
•Manual editing of documentation, the changelog, and other pages does not consume generation credits.
Steps
1.Open the Git sync area from your admin dashboard to view your connected repository and pending changes.
2.Check your current plan's credit usage to see how many generation credits remain.
3.Run a documentation generation job when you have new commits to draft from. Each job uses available credits.
4.Watch for an upgrade prompt if you reach your limit during generation.
5.Upgrade your plan to restore generation capacity and continue drafting documentation.
Credit Status Indicators
Status
What It Means
What To Do
Credits available
You have remaining capacity to draft documentation.
Run generation jobs as needed.
Limit reached during a job
A generation job stopped because your plan budget was exhausted.
Upgrade your plan to finish drafting.
Upgrade required
You cannot start a new generation job without more credits.
Choose a higher plan to continue using Git sync generation.
Tips
•Check your remaining credits before kicking off a large generation job so you don't get interrupted mid-draft.
•Use the check-for-updates option to confirm how many commits are pending before generating, so you spend credits only when there are real changes.
•Commits that aren't relevant to documentation are skipped automatically, helping you preserve credits.
You can keep editing documentation manually at any time without spending generation credits.
If you see the message to upgrade your plan to draft documents or continue using Git sync, your generation budget has been reached for your current plan.
Troubleshooting
•Generation won't start: If you're prompted to upgrade, your plan's credits are exhausted. Upgrade to resume drafting documentation.
•A job stopped early: The job may have reached your plan budget mid-run. Check your credit status and upgrade to complete the remaining pages.
•Credits seem to drop unexpectedly: Each generation job consumes credits based on the changes being drafted. Review your pending commits before generating to avoid surprises.
•No repository connected: Generation requires a connected GitHub repository. Connect one before checking credits or running a job.
Related topics: Sync and Generate Docs from Code, Connect GitHub Repository, Review Incoming Branch Changes.
