Choosing a Documentation Starting Point
When you first set up your documentation site in Hyperdocs, you decide how to begin: start from a ready-made template or connect a GitHub repository so docs can be generated from your code. This choice shapes how you'll create and maintain your content going forward.
How It Works
•Start from a documentation template to get a structured, pre-built set of pages you can edit right away.
•Connect a GitHub repository to automatically draft documentation based on your code and commits.
•Both options lead into the same rich block editor, where you organize content into pages and folders.
•You can switch directions later — for example, start with a template and connect GitHub afterward.
•Importing existing docs is planned as a future starting option.
Steps
1.Log in to Hyperdocs and complete the onboarding flow to reach your admin dashboard.
2.On the dashboard, review the available starting points for your documentation.
3.Select Template Docs to begin with a pre-built structure, or choose the GitHub option to generate docs from a repository.
4.If you choose GitHub, connect your GitHub account and select the repository you want to link.
5.Open the editor to start writing, structuring, or generating your documentation.
Starting Point Options
Option | Best For | What You Get |
|---|---|---|
Template Docs | Writers who want to author content manually | A pre-built set of pages ready to edit in the block editor |
Connect GitHub | Dev teams who want docs generated from code | Auto-drafted documentation based on repository commits |
Import Docs (Coming Soon) | Teams migrating existing documentation | A planned path to bring in content you already have |
Tips
•If you're unsure, start with Template Docs — it gives you a working structure immediately and you can connect GitHub later.
•Connecting GitHub is most valuable when your documentation closely tracks an active codebase.
•Generating docs from a repository uses your generation credits, so plan larger runs around your remaining balance.
You can always refine and reorganize generated or template content in the block editor before publishing.
Whichever path you choose, your site is available on a default Hyperdocs subdomain until you connect a custom domain.
Troubleshooting
•If no repositories appear after connecting GitHub, confirm your GitHub account is connected and that you've granted access to the repository you want.
•If documentation generation won't start, you may have reached your plan's generation limit — upgrade your plan to continue.
•If a generation job fails to queue, check for new commits, then try running the generation again.
•If the template doesn't load as expected, return to the dashboard and reopen the editor to refresh your starting content.
Related topics: Connect GitHub Repository, Sync and Generate Docs from Code, Edit Documentation Pages.