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.
Onboarding is the quick setup flow that prepares your Hyperdocs workspace and takes you straight to the admin dashboard. It helps you sign in, set up your account, and choose how you want to start building your documentation site so you can get going right away.
How It Works
•You sign in with your email or a Google account to start the onboarding flow.
•A short setup sequence collects the basics needed to create your workspace.
•You choose a starting point for your docs, such as a documentation template or a connected GitHub repository.
•Once setup is complete, you land on the admin dashboard with quick links to the editor and your live site.
•Your dashboard greets you by name and shows recent activity and a preview of your starter docs.
Steps
1.Log in to your account using your email address or by signing in with Google.
2.Follow the prompts in the onboarding flow to confirm your account details and create your workspace.
3.Choose how you want to start your documentation — pick a documentation template or connect a GitHub repository for auto-generated docs.
4.If prompted, configure basic branding such as your organization name so your workspace reflects your team.
5.Complete the final step to be taken to the admin dashboard, where you can open the editor or view your live site.
Onboarding Choices
Option
What It Does
Best For
Documentation template
Sets up a ready-made docs structure you can edit in the block editor.
Writing docs by hand from scratch.
Connect GitHub repository
Links a repository so docs can be auto-generated from your code.
Teams that want docs drafted from code changes.
Import existing docs
Brings in documentation you already have (coming soon).
Migrating from another platform.
Tips
•Signing in with Google is the fastest way to get started if you don't want to set up a password.
•You can change your starting point later — picking a template now doesn't stop you from connecting GitHub afterward.
•Set your organization name early so your workspace and dashboard greeting feel personalized from the start.
You can always revisit branding and general settings after onboarding to fine-tune your site's name, colors, and logos.
After onboarding, your dashboard shows recent activity and quick links so you can jump straight into editing or previewing your site.
Troubleshooting
•If sign-in fails, double-check your email and password, or try the Google sign-in option instead.
•If you don't reach the dashboard after onboarding, refresh the page and confirm you completed every step in the flow.
•If the GitHub option doesn't connect during onboarding, you can skip it and connect your repository later from the settings.
•If the import option appears unavailable, note that it's still coming soon — choose a template or GitHub for now.
Related topics: Choosing a Documentation Starting Point, Connecting a GitHub Repository, Configuring Branding and General Settings.
