# HyperDocs

> Generate documentation from your codebase, keep it updated as your product changes, and help users find answers through a built-in help center powered by your documentation.

## Getting Started

- [Home](https://docs.hyperdocs.io/getting-started/home): Explore Our Documentation, tutorials, and changelog in one place.
- [What is Hyperdocs](https://docs.hyperdocs.io/getting-started/what-is-hyperdocs): Discover Hyperdocs, the all-in-one platform for creating, maintaining, and publishing dynamic documentation for SaaS teams.
- [Create Your Account](https://docs.hyperdocs.io/getting-started/create-your-account): Sign up or log in to Hyperdocs easily using your email or Google account. Start your onboarding and access your admin dashboard today!
- [Completing Onboarding](https://docs.hyperdocs.io/getting-started/completing-onboarding): 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.
- [Choosing a Documentation Starting Point](https://docs.hyperdocs.io/getting-started/choosing-a-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.
- [Navigating the Dashboard](https://docs.hyperdocs.io/getting-started/navigating-the-dashboard): 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.

## Writing Documentation

- [Editing Pages with the Block Editor](https://docs.hyperdocs.io/writing-documentation/editing-pages-with-the-block-editor): The block editor is where you write and format your documentation content. Each page is built from individual blocks — headings, paragraphs, lists, quotes, code, and images — so you can shape clear, well-structured pages without any technical setup.
- [Organizing Pages and Folders](https://docs.hyperdocs.io/writing-documentation/organizing-pages-and-folders): The documentation editor lets you build and arrange your site's navigation by creating pages and folders in a flexible tree. Clear organization helps readers find what they need quickly and gives your docs a logical, professional structure.
- [Configuring Site Navigation](https://docs.hyperdocs.io/writing-documentation/configuring-site-navigation): Your documentation navigation is built from the pages and folders in your docs tree. By structuring this tree thoughtfully, you control the order readers encounter your content and how easily they move between topics on your published site.

## GitHub Integration

- [Connecting a GitHub Repository](https://docs.hyperdocs.io/github-integration/connecting-a-github-repository): Connecting a GitHub repository lets Hyperdocs automatically draft documentation from your code. By authorizing GitHub and linking a repository, you can keep your docs in sync with your codebase and generate updated pages whenever new commits are pushed.
- [Generating Docs from Code](https://docs.hyperdocs.io/github-integration/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.
- [Reviewing Branch Changes](https://docs.hyperdocs.io/github-integration/reviewing-branch-changes): When code is pushed to your connected repository, Hyperdocs detects the new commits and helps you keep your documentation up to date. You can review what changed, generate fresh draft documentation, and decide whether to accept or reject the incoming updates.

## Changelog and Pages

- [Publishing Changelog Updates](https://docs.hyperdocs.io/changelog-and-pages/publishing-changelog-updates): The changelog lets you share product updates with your users in a clean, chronological layout. Each entry has its own date, optional tags, and richly formatted content, so visitors can quickly scan what changed and when. Keeping your changelog current builds trust and keeps your audience informed about new features and fixes.
- [Editing the Home Page](https://docs.hyperdocs.io/changelog-and-pages/editing-the-home-page): The home page is the landing page visitors see when they arrive at your documentation site. With the card-based block editor, you can shape this page to highlight key sections, welcome users, and guide them toward the content that matters most.
- [Editing the Help Center](https://docs.hyperdocs.io/changelog-and-pages/editing-the-help-center): The help center is a dedicated page on your documentation site where readers can find answers, guides, and support resources in one welcoming place. With the help center editor you can craft an inviting hero section, arrange content blocks, and reset everything to a clean default layout whenever you need a fresh start.

## Branding and Settings

- [Configuring Branding and General Settings](https://docs.hyperdocs.io/branding-and-settings/configuring-branding): General Settings let you shape how your documentation site looks and feels to visitors. Here you set your organization name, write a description, choose a brand accent color, upload logos and a favicon, and decide whether Hyperdocs branding appears on your site.
- [Managing Account Settings](https://docs.hyperdocs.io/branding-and-settings/managing-account-settings): Account settings let you keep your personal and workspace details up to date and sign out of your Hyperdocs workspace whenever you need to. Keeping this information current ensures your dashboard, branding, and published site reflect the right details for you and your team.
- [Tracking Generation Credits](https://docs.hyperdocs.io/branding-and-settings/tracking-generation-credits): 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.

## Publishing Your Site

- [Previewing and Publishing the Site](https://docs.hyperdocs.io/publishing-your-site/previewing-and-publishing): Previewing and publishing lets you see exactly how your documentation, changelog, and home pages will appear to visitors before they go live. When you're happy with the result, you can publish your changes to your public site with confidence.
- [Connecting a Custom Domain](https://docs.hyperdocs.io/publishing-your-site/connecting-a-custom-domain): Connecting a custom domain lets you serve your documentation, changelog, and help center pages from your own branded web address instead of the default Hyperdocs subdomain. This makes your docs feel like a seamless part of your product and builds trust with your readers.

## Answer Agent

- [Answer Agent](https://docs.hyperdocs.io/answer-agent/answer-agent): Answer Agent is a chat widget that appears on your published documentation site and lets visitors ask questions in natural language. It answers from your documentation content and can be fully configured from the admin dashboard — including what it says when it can't answer, what feedback options it shows, and how it looks.
- [Answer Agent Analytics](https://docs.hyperdocs.io/answer-agent/answer-agent-analytics): Discover visitor engagement and feedback metrics with Answer Agent Analytics. Analyze chat interactions and improve responses effectively.
- [Sample](https://docs.hyperdocs.io/answer-agent/sample): Welcome to the Sample section.

## Optional

- [Help Center](https://docs.hyperdocs.io/help-center)
- [Changelog](https://docs.hyperdocs.io/changelog)
- [Full documentation (single file)](https://docs.hyperdocs.io/llms-full.txt)