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.
The dashboard is your home base in Hyperdocs. It welcomes you with a personalized greeting, surfaces recent activity, and gives you quick links to jump straight into the editor or open your live site.
How It Works
•A personalized greeting welcomes you each time you sign in.
•A recent activity area highlights the latest changes across your documentation, changelog, and connected repository.
•A starter kit or docs preview shows what your published documentation looks like.
•Quick links let you open the editor or view the live public site in a single click.
•Remaining generation credits are visible so you can track usage against your plan.
Steps
1.Sign in to Hyperdocs and complete onboarding to land on the admin dashboard.
2.Review the greeting and recent activity to see what's changed since your last visit.
3.Use the starter kit or docs preview to check how your documentation currently appears.
4.Click the quick link to open the editor and start creating or editing content.
5.Click the View Live Site link to open your published documentation in a new view.
6.Check your remaining generation credits before starting a documentation generation job.
Dashboard Areas
Area
What It Shows
What You Can Do
Greeting
A personalized welcome message.
Confirm you're in the right workspace.
Recent Activity
Latest edits and repository updates.
Catch up on recent changes at a glance.
Docs Preview
A snapshot of your starter kit or current docs.
See how content looks before publishing.
Quick Links
Shortcuts to the editor and live site.
Open the editor or visit your public site.
Generation Credits
Remaining credits against your plan.
Track usage and upgrade when needed.
Tips
•Start each session on the dashboard to quickly orient yourself before diving into edits.
•Use the recent activity area to spot repository changes that may need review.
•Keep an eye on your generation credits so you're not interrupted mid-task.
The View Live Site link is the fastest way to confirm your published changes look right to your audience.
If you reach your generation credit limit, you'll be prompted to upgrade your plan before running new documentation jobs.
Troubleshooting
•If recent activity looks empty, try refreshing — new commits and edits may take a moment to appear.
•If the docs preview doesn't load, confirm you've selected a starting point and added at least one page.
•If the View Live Site link shows nothing, make sure you've published your changes first.
•If your credits show as exhausted, upgrade your plan to continue generating documentation.
Related topics: Editing Documentation Pages, Preview and Publish the Site, Track Generation Credits.
