# 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.

---

# Home
Source: https://docs.hyperdocs.io/getting-started/home

# Welcome to Hyperdocs' Documentation

Explore Our Documentation, tutorials, and changelog in one place.

---

# What is Hyperdocs
Source: https://docs.hyperdocs.io/getting-started/what-is-hyperdocs

# What is Hyperdocs

Hyperdocs is an agent-ready documentation platform for SaaS teams.

It helps you create, maintain, publish, and improve documentation without managing everything manually. Instead of treating documentation like a static website, Hyperdocs gives you a system that helps your docs stay aligned with your product as it changes.

With Hyperdocs, you can create product documentation, help center content, API documentation, and changelogs in one place. You can publish public documentation for customers, organize internal knowledge, and manage documentation with more structure and control.

Hyperdocs also includes built-in product intelligence for modern documentation workflows:

- Docs Agent helps draft new documentation and update existing content

- GitHub Sync helps keep documentation aligned with product changes

- Answer Agent helps users find answers directly from your docs

- Analytics and feedback help you understand what users are searching for, what content is missing, and where docs need improvement

Hyperdocs is also built for modern AI discovery. Features like AI SEO tags, `llms.txt`, markdown output, and automatic sitemaps help make your documentation easier for search engines, answer engines, and AI agents to understand.

##  What you can use Hyperdocs for

Teams use Hyperdocs to:

- create product documentation

- build help centers

- publish API documentation

- maintain changelogs

- keep docs updated as products evolve

- improve self-serve support

- identify documentation gaps through analytics and feedback

- prepare documentation for AI agents and answer engines

## How Hyperdocs works

Hyperdocs combines documentation creation, maintenance, answering, and improvement into one workflow.

A typical flow looks like this:

1. You create or import your documentation into Hyperdocs

2. GitHub Sync helps detect product changes that may affect docs

3. Docs Agent helps draft new pages or update outdated content

4. Answer Agent helps users get answers from your documentation

5. Analytics and feedback show what users need and what your docs still miss

##  Why teams use Hyperdocs

Most documentation gets outdated because product changes move faster than manual documentation workflows.

Hyperdocs is built to reduce that gap. It helps teams spend less time chasing documentation debt and more time publishing useful, accurate content.

Instead of using separate tools for docs, search, feedback, AI discoverability, and maintenance, Hyperdocs brings those workflows together in one platform.

##  In short

Hyperdocs helps SaaS teams build documentation that is easier to create, easier to maintain, easier to search, and better prepared for both users and AI systems.

> **CHECK:** Docs Agent writes. GitHub Sync maintains. Answer Agent answers.

Together, Hyperdocs helps your documentation operate with your product.

---

# Create Your Account
Source: https://docs.hyperdocs.io/getting-started/create-your-account

# Create Your Account

Getting started with Hyperdocs begins with creating your account or signing in. You can sign up using your company email address or your Google account, and once you're in, you'll be guided through a quick onboarding flow that lands you on your admin dashboard ready to build documentation.

## How It Works

- Create an account with your email address or sign in instantly using Google.
- Complete a short onboarding flow that prepares your workspace.
- Land directly on your admin dashboard with a personalized greeting and quick actions.
- Return anytime by logging back in with the same method you used to sign up.
- Sign out securely from your account settings when you're done.
## Steps

1. Open the Hyperdocs sign-up or login page in your browser.
1. Choose how you want to continue: enter your email address or select Continue with Google.
1. If using email, provide your details and confirm your account; if using Google, approve the connection in the pop-up.
1. Complete the onboarding steps to set up your workspace basics.
1. Arrive at your admin dashboard, where you can open the editor, view your site, or start a documentation project.
## Sign-In Options

| Method | Best For | What You Need |
| --- | --- | --- |
| Email | Users who prefer a standalone account not tied to a social provider. | A valid email address. |
| Google | Fast, one-click access without creating a separate password. | A Google account you can authorize. |

## Tips

- Use the same sign-in method each time so your workspace and documentation stay linked to one account.
- Signing in with Google is the quickest path if you want to skip creating and remembering a separate password.
- After your first login, finish onboarding right away so your dashboard and starter docs are ready to use.
> **TIP:** You can sign out anytime from your account settings, and you'll be asked to confirm before your session ends.

> **INFO:** New accounts are taken straight to the admin dashboard after onboarding, where quick links let you jump into the editor or view your live site.

## Troubleshooting

- If the Google pop-up doesn't appear, check that your browser isn't blocking pop-ups and try again.
- If you can't log in, confirm you're using the same method (email or Google) you originally signed up with.
- If onboarding doesn't load, refresh the page or sign out and back in to restart the flow.
- If you land on a blank screen after logging in, clear your browser cache and reload to reach the dashboard.
Related topics: Viewing the Dashboard Overview, Configuring Branding and General Settings, Choosing a Documentation Starting Point.

---

# Completing Onboarding
Source: https://docs.hyperdocs.io/getting-started/completing-onboarding

# 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.

## 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.
1. Follow the prompts in the onboarding flow to confirm your account details and create your workspace.
1. Choose how you want to start your documentation — pick a documentation template or connect a GitHub repository for auto-generated docs.
1. If prompted, configure basic branding such as your organization name so your workspace reflects your team.
1. 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.
> **TIP:** You can always revisit branding and general settings after onboarding to fine-tune your site's name, colors, and logos.

> **INFO:** 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.

---

# Choosing a Documentation Starting Point
Source: https://docs.hyperdocs.io/getting-started/choosing-a-starting-point

# 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.
1. On the dashboard, review the available starting points for your documentation.
1. Select Template Docs to begin with a pre-built structure, or choose the GitHub option to generate docs from a repository.
1. If you choose GitHub, connect your GitHub account and select the repository you want to link.
1. 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.
> **TIP:** You can always refine and reorganize generated or template content in the block editor before publishing.

> **INFO:** 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.

---

# Navigating the Dashboard
Source: https://docs.hyperdocs.io/getting-started/navigating-the-dashboard

# 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.

## 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.
1. Review the greeting and recent activity to see what's changed since your last visit.
1. Use the starter kit or docs preview to check how your documentation currently appears.
1. Click the quick link to open the editor and start creating or editing content.
1. Click the View Live Site link to open your published documentation in a new view.
1. 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.
> **TIP:** The View Live Site link is the fastest way to confirm your published changes look right to your audience.

> **INFO:** 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.

---

# Editing Pages with the Block Editor
Source: https://docs.hyperdocs.io/writing-documentation/editing-pages-with-the-block-editor

# 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.

## How It Works

- Content is organized into stackable blocks, so you can add, rearrange, and remove sections independently.
- You can structure pages with multiple heading levels for titles, sections, and subsections.
- Inline text formatting includes bold, italic, underline, strikethrough, and inline code.
- Block types include bulleted and numbered lists, blockquotes, dividers, code blocks, and images.
- Your changes are saved with your page and shown exactly as written when the site is published.
## Steps

1. Open the documentation editor and select the page you want to edit from the navigation tree.
1. Click into the page and start typing, or add a new block where you want your content to appear.
1. Choose a block type — such as a heading, paragraph, list, quote, code block, or image — to format that section.
1. Highlight text to apply inline formatting like bold, italic, underline, or inline code.
1. Reorder, edit, or delete blocks until the page reads the way you want.
1. Preview the page, then publish to make your changes live on your site.
## Available Block Types

| Block | What it's for |
| --- | --- |
| Headings (H1, H2, H3) | Page titles, section headers, and subsections to organize content. |
| Paragraph | Standard body text with inline formatting. |
| Bulleted & numbered lists | Step-by-step instructions or grouped points. |
| Blockquote | Highlight callouts, tips, or quoted notes. |
| Code block & inline code | Display commands or code snippets with monospaced styling. |
| Divider & image | Separate sections visually or add screenshots and illustrations. |

## Tips

- Use a single H1 for the page title and H2/H3 for sections so readers can scan your content easily.
- Use inline code for short references like names or values, and code blocks for multi-line snippets.
- Break long paragraphs into lists or shorter sections to keep pages readable.
> **TIP:** Preview your page before publishing — it shows exactly how your formatting will appear to readers on the live site.

> **INFO:** Empty paragraphs are rendered as spacing, so you can add a blank block to create breathing room between sections.

## Troubleshooting

- Changes not appearing live? Make sure you published the page after editing — saved edits stay in the editor until published.
- Formatting looks off? Check that the correct block type is applied and that inline formatting wasn't accidentally left active.
- Image not showing? Confirm the image was added correctly and that its source is valid.
- Can't find a page to edit? Verify it exists in the navigation tree and hasn't been moved into a different folder.
Related topics: Organizing Your Docs Structure, Preview and Publish the Site, Editing the Home Page.

---

# Organizing Pages and Folders
Source: https://docs.hyperdocs.io/writing-documentation/organizing-pages-and-folders

# 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.

## How It Works

- Create new pages to hold individual documentation topics within your site's tree.
- Group related pages inside folders to form sections and subsections in your navigation.
- Rename and delete pages or folders at any time to keep your structure current.
- Drag and drop items to reorder them or nest them under other folders.
- Changes to the navigation tree appear in your live preview before you publish.
## Steps

1. Open the documentation editor from your dashboard to view the current page and folder tree.
1. Click the add button to create a new page or folder, then give it a clear, descriptive name.
1. To rename an item, select it and edit its title; to remove it, choose the delete option and confirm.
1. Drag any page or folder up or down to reorder it, or drop it onto a folder to nest it inside.
1. Review the structure in the live preview, then publish to update the public navigation.
## Page and Folder Actions

| Action | What It Does | Applies To |
| --- | --- | --- |
| Create | Adds a new item to the navigation tree | Pages and folders |
| Rename | Changes the displayed title | Pages and folders |
| Reorder | Drag to change position in the list | Pages and folders |
| Nest | Places a page or folder inside another folder | Pages and folders |
| Delete | Permanently removes the item from the tree | Pages and folders |

## Tips

- Use folders to group related topics so readers can scan your navigation at a glance.
- Keep page names short and descriptive — they double as navigation labels on your published site.
- Order your most important pages near the top so visitors see them first.
> **TIP:** Preview your site after reordering to confirm the navigation flows the way you expect before publishing.

> **WARNING:** Deleting a folder removes the pages nested inside it, so move any pages you want to keep before deleting.

## Troubleshooting

- If a new page does not appear, refresh the editor to make sure the latest tree is loaded.
- If drag-and-drop will not nest an item, drop it directly onto the folder rather than between pages.
- If changes are missing on your live site, confirm you published after editing the navigation.
- If a deleted page reappears, check that the deletion was confirmed and the editor finished saving.
Related topics: Edit Documentation Pages, Preview and Publish the Site, Configure Branding and General Settings.

---

# Configuring Site Navigation
Source: https://docs.hyperdocs.io/writing-documentation/configuring-site-navigation

# 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.

## How It Works

- The docs editor displays your pages and folders in a navigable tree that mirrors the navigation readers see on your live site.
- You can create new pages and folders, rename them, and delete items you no longer need.
- Drag-and-drop reordering lets you change the sequence of pages and folders to match your preferred reading flow.
- Nesting pages inside folders creates grouped sections, giving your navigation a clear hierarchy.
- Changes to the tree are reflected in the live preview and on your public site once published.
## Steps

1. Open the documentation editor from your dashboard to view the current page and folder tree.
1. Create a new folder to group related topics, or add a new page where you want fresh content to live.
1. Rename pages and folders so their titles clearly describe what readers will find inside.
1. Drag items up or down, or into a folder, to set the order and nesting of your navigation.
1. Delete any outdated pages or folders to keep the navigation clean and focused.
1. Open the live preview to confirm the navigation reads the way you intended, then publish your changes.
## Navigation Actions

| Action | What It Does | Best Used For |
| --- | --- | --- |
| Create page | Adds a new content page to the tree | Individual topics or articles |
| Create folder | Adds a grouping container for pages | Sections with multiple related pages |
| Rename | Updates the title shown in navigation | Clarifying labels for readers |
| Drag-and-drop | Reorders or nests items | Setting reading sequence and hierarchy |
| Delete | Removes a page or folder from the tree | Clearing outdated content |

## Tips

- Order your most important pages near the top of the tree so readers find essential information first.
- Group related pages under clearly named folders to keep deep topics tidy and easy to scan.
- Use short, descriptive titles since they double as navigation labels on your live site.
> **TIP:** Always check the live preview before publishing to make sure your navigation flows logically for first-time readers.

> **WARNING:** Deleting a folder may remove the pages nested inside it, so move any content you want to keep before deleting.

## Troubleshooting

- If your navigation changes don't appear on the live site, confirm you published after editing the tree.
- If drag-and-drop doesn't drop an item where expected, release it directly over the target folder or position and try again.
- If a renamed page still shows the old title in preview, refresh the preview to load the latest structure.
- If a page seems missing, check whether it was accidentally nested inside a collapsed folder in the tree.
Related topics: Edit documentation pages, Preview and publish the site, Edit the home page.

---

# Connecting a GitHub Repository
Source: https://docs.hyperdocs.io/github-integration/connecting-a-github-repository

# 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.

## How It Works

- Authorize Hyperdocs to access your GitHub account using a secure OAuth sign-in flow.
- Choose a repository from your GitHub account and link it to your docs project.
- Hyperdocs reads the repository's default branch and checks for pending commits.
- Once connected, you can trigger documentation generation jobs that draft docs from code changes.
- Your connection status and linked GitHub username are shown so you always know what's linked.

## Steps

1. Open your Hyperdocs admin dashboard and go to the Git Sync section.
1. Select the option to connect your GitHub account. You'll be redirected to GitHub to authorize access.
1. Approve the authorization on GitHub. After approval, you're returned to Hyperdocs and your GitHub username appears as connected.\
1. Choose the repository you want to link from your available repositories.
1. Hyperdocs loads the default branch and checks for any pending commits ready for documentation.
1. Select Generate to draft documentation from the connected repository's changes.

## Connection Status Indicators

| Status | What It Means |
| --- | --- |
| Connected | Your GitHub account is authorized and your username is displayed. |
| Not connected | No GitHub account is linked yet; you'll be prompted to connect. |
| Pending commits found | New commits are available and ready for documentation generation. |
| Up to date | No new updates are available; your codebase matches your docs. |

## Tips

- Use the check-for-updates action to confirm how many pending commits are waiting before you generate docs.
- Commits that don't contain documentation-relevant changes are automatically acknowledged so they won't clutter your pending list.
> **INFO:** Documentation generation uses your plan's generation credits. If you reach your limit, you'll be prompted to upgrade to continue.

> **TIP:** After connecting, return to the Git Sync section anytime to re-check commits and run a fresh generation job.

## Troubleshooting

- If no repositories appear after connecting, confirm you authorized access to the correct GitHub account and that it has repositories available.
- If your account shows as not connected, restart the authorization flow from the Git Sync section and approve all requested permissions.
- If checking for commits fails, retry the check; a temporary connection issue can prevent commit history from loading.
- If documentation generation won't start and shows an upgrade message, you've reached your generation credit limit and need to upgrade your plan.
Related topics: Sync and Generate Docs from Code, Review Incoming Branch Changes, Track Generation Credits.

---

# Generating Docs from Code
Source: https://docs.hyperdocs.io/github-integration/generating-docs-from-code

# 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.

## How It Works

- Hyperdocs reads the commit history of your connected repository and identifies which changes are relevant for documentation.
- A pending commit count shows you how many new updates are waiting to be drafted into docs.
- Triggering a generation job queues the work and drafts new documentation pages based on your code changes.
- You can watch live job progress and status messages as the documentation is being generated.
- Commits that aren't relevant for documentation are automatically acknowledged so they don't clutter your pending updates.
## Steps

1. Open the Git Sync page from your admin dashboard. Make sure your GitHub account and repository are already connected.
1. Click the check or refresh option to look for new commits. Hyperdocs scans your repository's default branch for the latest changes.
1. Review the pending commit count and the list of commits to see what has changed since your last sync.
1. Click Generate to queue a documentation generation job. The job is added to the queue and begins drafting docs.
1. Watch the progress bar and status messages until the job completes, then review the newly drafted pages in your editor.
## Sync Status Indicators

| Indicator | What It Means |
| --- | --- |
| Pending commits found | New code changes are ready to be drafted into documentation. |
| No new updates | Your codebase is already up to date with your docs. |
| Job queued | Your generation job has been accepted and is waiting to start. |
| In progress | Documentation is actively being drafted; a progress percentage is shown. |
| Completed | The drafted docs are ready for you to review and refine. |

## Tips

- Check for new commits regularly so your documentation stays aligned with your latest code.
- Treat generated pages as drafts — review and edit them in the block editor before publishing to your live site.
- Keep an eye on your generation credits, since each job draws from your plan's allowance.
> **TIP:** Generation jobs run in the background — you can leave the page and return to check progress later.

> **WARNING:** If you reach your plan limit, generation will stop and you'll be prompted to upgrade to continue drafting documents.

## Troubleshooting

- No repository to check: confirm your GitHub account is connected and a repository has been linked to your project.
- Generation won't start: if you see an upgrade message, your plan's credits may be exhausted — upgrade to continue using doc generation.
- Commit history fails to load: try refreshing the sync status; a temporary connection issue may have interrupted the check.
- Commits don't appear as pending: changes that aren't relevant for documentation are acknowledged automatically and won't show as updates.
Related topics: Connect GitHub Repository, Review Incoming Branch Changes, Track Generation Credits.

---

# Reviewing Branch Changes
Source: https://docs.hyperdocs.io/github-integration/reviewing-branch-changes

# 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.

## How It Works

- Hyperdocs watches your connected repository and notifies you in real time when new changes are pushed to the tracked branch.
- Pending commits are listed so you can see exactly what has changed since your last sync.
- Only commits that affect documentation are flagged as ready to generate docs, while non-relevant commits are acknowledged automatically.
- Generation jobs draft updated documentation from your code, with live progress shown as the job runs.
- You review the proposed changes and choose to accept them into your docs or reject them to keep your existing content.
## Steps

1. Open the Git Sync area from the admin dashboard to view your connected repository and its tracked branch.
1. Select Check for updates to fetch the latest commits. Hyperdocs shows how many pending commits were found, or confirms your codebase is already up to date.
1. Review the list of pending commits, including their messages and dates, to understand what changed in the repository.
1. Choose Generate docs to queue a generation job that drafts updated documentation from the relevant commits, and watch its progress.
1. When the draft is ready, review the proposed changes for each affected page.
1. Accept the changes to apply them to your docs, or reject them to keep your current content unchanged.
## Change Review Actions

| Action | What It Does |
| --- | --- |
| Check for updates | Fetches the latest commits from your connected branch and reports how many are pending. |
| Generate docs | Queues a job that drafts updated documentation from the relevant commits. |
| Accept changes | Applies the proposed updates to the affected documentation pages. |
| Reject changes | Discards the proposed updates and keeps your existing content as it is. |

## Tips

- Check for updates regularly so your published docs stay aligned with the latest code in your repository.
- Always review the proposed changes carefully before accepting, especially for pages you have manually edited.
- Generation jobs use your plan's documentation generation credits, so keep an eye on your remaining balance.
> **INFO:** Commits that don't affect documentation are acknowledged automatically, so you only review changes that actually matter for your docs.

> **WARNING:** If you reach your plan's generation limit, you'll be prompted to upgrade before you can draft new documentation or continue using Git Sync.

## Troubleshooting

- If no commits appear, confirm your GitHub account is connected and that a repository is linked to your project.
- If checking for updates shows your codebase is up to date, there are no new commits since your last sync — push new changes to trigger updates.
- If a generation job fails to start, you may have reached your plan limit; review your remaining generation credits and upgrade if needed.
- If real-time notifications stop appearing, refresh the page and run Check for updates manually to re-sync your repository status.
Related topics: Connect GitHub Repository, Sync and Generate Docs from Code, Track Generation Credits.

---

# Publishing Changelog Updates
Source: https://docs.hyperdocs.io/changelog-and-pages/publishing-changelog-updates

# 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.

## How It Works

- Add dated entries that appear in chronological order, grouped by year, on your public changelog page.
- Write and format each entry using a rich block editor with headings, lists, quotes, code, and images.
- Apply custom tags with their own labels, colors, and icons to categorize updates such as New, Improved, or Fixed.
- Edit existing entries at any time to correct details or expand on a release.
- Preview your changelog and publish it to your live site so visitors can filter entries by tag.
## Steps

1. Open the changelog editor from your admin area.
1. Click to add a new entry and set its publication date so it lands in the correct spot on the timeline.
1. Give the entry a clear title that summarizes the update.
1. Apply one or more tags to categorize the update, choosing existing tags or creating new ones with custom labels, colors, and icons.
1. Write the entry content in the block editor, adding headings, bullet lists, code snippets, or images as needed.
1. Save your changes, preview the result, and publish to make the update visible on your public changelog.
## Entry Options

| Option | What It Does |
| --- | --- |
| Date | Sets when the update is shown; entries are grouped and ordered by year and date. |
| Title | A short headline shown at the top of the entry to summarize the release. |
| Tags | Custom labels with colors and icons that let visitors filter entries by category. |
| Content | Rich formatted body supporting headings, lists, quotes, code blocks, and images. |

## Tips

- Use consistent tag names like New, Improved, and Fixed so visitors can quickly filter updates.
- Lead each entry with a concise title and a short summary before diving into detailed bullet points.
- Pick distinct tag colors and icons so categories stand out at a glance on the public page.
> **TIP:** Always preview an entry before publishing to confirm formatting, tags, and the date appear exactly as you intend.

> **INFO:** Entries are organized by year, so setting an accurate date keeps your timeline tidy and easy to navigate.

## Troubleshooting

- Entry not appearing on the live site? Make sure you saved and published your changes after editing.
- Entry showing under the wrong year? Check the entry's date, since entries are grouped by the year you set.
- Tag colors or icons not displaying correctly? Reopen the tag settings and confirm a color and icon are selected.
- Formatting looks off in the preview? Return to the block editor and adjust the affected blocks, then preview again.
Related topics: Editing Documentation Pages, Editing the Home Page, Preview and Publish Your Site.

---

# Editing the Home Page
Source: https://docs.hyperdocs.io/changelog-and-pages/editing-the-home-page

# 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.

## How It Works

- Build your landing page using a flexible, card-based block editor that lets you arrange sections visually.
- Add headings, paragraphs, links, and content cards to organize how visitors navigate your docs.
- Apply your brand accent color, logos, and styling so the home page matches the rest of your site.
- Reset the page back to the default template at any time if you want to start fresh.
- Preview your changes before publishing, then push them live to your public site.
## Steps

1. Open the admin dashboard and select the home page editor.
1. Add or edit blocks by clicking into the canvas and choosing headings, text, links, or cards.
1. Arrange the cards and sections in the order you want visitors to see them.
1. Click Preview to see how the home page will appear on the live site.
1. When you are satisfied, publish your changes to update the public home page.
## Home Page Editing Options

| Option | What It Does |
| --- | --- |
| Content cards | Add highlighted cards that link to key pages or sections of your documentation. |
| Headings & text | Write a welcome message, introduction, or section titles to guide visitors. |
| Branding | Your accent color and logos from general settings are applied automatically. |
| Reset to default | Restore the original starter template if you want to begin again. |

## Tips

- Keep your home page focused — use cards to point visitors to your most-used sections rather than overcrowding the page.
- Set your brand accent color and logos in general settings first, so the home page reflects your branding from the start.
- Always preview before publishing to confirm the layout looks the way you expect on the live site.
> **TIP:** Use the reset option to quickly recover a clean layout if your edits get cluttered — but remember it replaces your current content.

> **WARNING:** Resetting to the default template cannot be undone, so consider previewing your current version before you reset.

## Troubleshooting

- Changes not appearing on the live site? Make sure you clicked Publish — saving alone may not push updates to visitors.
- Branding looks off? Confirm your accent color, logos, and favicon are set correctly in general settings.
- Lost your edits after a reset? Resetting restores the default template and replaces your custom content, so re-add your blocks as needed.
- Preview not loading? Try refreshing the editor and ensure your site has been published at least once.
Related topics: Configure Branding and General Settings, Preview and Publish the Site, Edit the Help Center.

---

# Editing the Help Center
Source: https://docs.hyperdocs.io/changelog-and-pages/editing-the-help-center

# 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.

## How It Works

- Configure a hero section at the top of the page with a headline and supporting text to greet your readers.
- Add and arrange content blocks below the hero to highlight key articles, categories, or quick links.
- Use the rich block editor to format text, add headings, lists, and other elements within each block.
- Reset the entire help center back to the default template at any time to start over.
- Preview your changes and publish them live so visitors see the updated help center on your site.
## Steps

1. Open the admin area and select the Help Center editor from the navigation.
1. Edit the hero section by updating the headline and supporting text that appear at the top of the page.
1. Add or rearrange content blocks below the hero, using the block editor to format each one with headings, text, and lists.
1. Use the live preview to check how the help center looks to your readers.
1. Publish your changes to make the updated help center visible on your public site.
## Help Center Sections

| Section | Purpose | Editable Options |
| --- | --- | --- |
| Hero | Welcomes visitors and sets the tone for the help center. | Headline and supporting text. |
| Content Blocks | Showcase guides, categories, and helpful links. | Headings, formatted text, lists, and arrangement. |
| Default Template | Provides a clean starting layout you can restore anytime. | Reset to default. |

## Tips

- Keep your hero headline short and clear so readers immediately understand they've reached the help center.
- Group related guides into separate content blocks to make the page easy to scan.
- Preview before publishing to confirm formatting and links look the way you expect.
> **WARNING:** Resetting to the default template replaces your current help center layout. Make sure you no longer need your existing content before resetting.

> **TIP:** Match your help center wording to your brand voice so it feels consistent with the rest of your documentation.

## Troubleshooting

- Changes not showing on the live site? Make sure you published after editing — saved drafts are not visible to readers until published.
- Hero text looks empty? Confirm you entered a headline and supporting text and saved the section.
- Accidentally reset the page? Re-add your content blocks manually, as resetting restores the default layout and cannot recover prior edits.
- Formatting appears incorrect in preview? Recheck the block editor and adjust headings or lists before publishing.
Related topics: Edit the Home Page, Manage a Changelog, Preview and Publish the Site.

---

# Configuring Branding and General Settings
Source: https://docs.hyperdocs.io/branding-and-settings/configuring-branding

# Configuring Branding and General Settings

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.

## How It Works

- Set your organization name and description, which appear across your published site.
- Pick a brand accent color that is applied to highlights, links, and interface elements throughout your docs.
- Upload separate logos for light and dark modes, plus a favicon for browser tabs.
- Toggle Hyperdocs branding on or off to control whether the platform's badge shows on your site.
- Save your changes to update the public-facing site instantly.
## Steps

1. Open the admin dashboard and go to General Settings.
1. Enter your organization name and a short description that represents your product or team.
1. Choose your brand accent color so highlights and links match your visual identity.
1. Upload your light and dark logos, then add a favicon for the browser tab.
1. Decide whether to keep the Hyperdocs branding toggle on or off.
1. Save your changes to apply them to your live site.
## Available Settings

| Setting | What It Controls |
| --- | --- |
| Organization Name | The name shown across your documentation site. |
| Description | A short summary of your product or team displayed on the site. |
| Accent Color | The highlight color used for links, buttons, and accents. |
| Light & Dark Logos | Logos shown depending on the visitor's light or dark theme. |
| Favicon | The small icon displayed in the browser tab. |
| Hyperdocs Branding | A toggle that shows or hides the Hyperdocs badge on your site. |

## Tips

- Use a transparent logo so it looks clean against both light and dark backgrounds.
- Pick an accent color with enough contrast to stay readable in both themes.
- Preview your site after saving to confirm logos and colors display as expected.
> **TIP:** Upload both light and dark versions of your logo for a polished look no matter which theme visitors prefer.

> **INFO:** Turning off Hyperdocs branding may depend on your current plan.

## Troubleshooting

- If your changes don't appear, make sure you saved them and refresh your live site or preview.
- If a logo looks stretched or cropped, re-upload it using a properly sized image.
- If the favicon doesn't update, clear your browser cache, as browsers often store the old icon.
- If the branding toggle is unavailable, check whether your plan supports hiding Hyperdocs branding.
Related topics: Connect a Custom Domain, Edit the Home Page, Preview and Publish the Site.

---

# Managing Account Settings
Source: https://docs.hyperdocs.io/branding-and-settings/managing-account-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.

## How It Works

- Open a dedicated account settings panel from anywhere in the admin dashboard.
- Review your sign-in details, including the email or Google account you used to log in.
- Update your personal details and save changes that apply across your workspace.
- Sign out securely with a confirmation step so you never log out by accident.
- Return to the dashboard quickly after making changes to continue editing your docs.
## Steps

1. Open the admin dashboard and locate the account or profile menu, usually shown with your name or avatar.
1. Select Account Settings to open the settings panel for your profile.
1. Review your account details, such as your name and the email or Google account linked to your login.
1. Make any updates you need, then save your changes to apply them to your workspace.
1. When you are finished, choose Sign Out and confirm to securely end your session.
## Account Settings Options

| Option | What It Does |
| --- | --- |
| Account details | View and update your personal profile information for your workspace. |
| Sign-in method | See whether you logged in with an email address or your Google account. |
| Sign out | End your current session with a confirmation prompt to prevent accidental logout. |
| Plan and credits | Check your remaining documentation generation credits and current plan usage. |

## Tips

- Save your changes before navigating away so your updates are not lost.
- If you share a device with teammates, always sign out when you finish working.
- Keep an eye on your generation credits in the account area so you know when an upgrade may be needed.
> **TIP:** Looking to change your site name, logos, or brand color? Those are managed in General Settings, not the account panel.

> **WARNING:** Signing out ends your session immediately. Make sure all your edits are saved before you confirm.

## Troubleshooting

- Changes not saving? Confirm you selected the save button and that you have a stable internet connection.
- Signed in with Google but want to switch accounts? Sign out fully, then log back in with the correct Google account.
- If the sign-out confirmation does not appear, refresh the page and try again from the account menu.
- Seeing a prompt to upgrade? You may have reached your generation credit limit, which is tracked alongside your account.
Related topics: Configuring Branding and General Settings, Viewing the Dashboard Overview, Tracking Generation Credits.

---

# Tracking Generation Credits
Source: https://docs.hyperdocs.io/branding-and-settings/tracking-generation-credits

# 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.

## 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.
1. Check your current plan's credit usage to see how many generation credits remain.
1. Run a documentation generation job when you have new commits to draft from. Each job uses available credits.
1. Watch for an upgrade prompt if you reach your limit during generation.
1. 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.
> **TIP:** You can keep editing documentation manually at any time without spending generation credits.

> **WARNING:** 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.

---

# Previewing and Publishing the Site
Source: https://docs.hyperdocs.io/publishing-your-site/previewing-and-publishing

# Previewing and Publishing the Site

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.

## How It Works

- Open a live preview of your docs, changelog, home page, and help center to see them rendered just as visitors will.
- Review formatting, layout, branding, and navigation in context before anything is made public.
- Publish your changes to push the latest content to your live, public-facing site.
- Access your site on the default Hyperdocs subdomain or your connected custom domain once published.
- Jump straight from the dashboard or editor to open the live site in a new view.
## Steps

1. Open the editor and make the content changes you want across your docs, changelog, or home page.
1. Select the preview option to open a live view of the page you're working on.
1. Check that headings, text formatting, lists, images, branding, and navigation all appear the way you expect.
1. Return to the editor to fix anything that needs adjusting, then preview again.
1. When everything looks right, select Publish to make your changes available on the public site.
1. Open your live site on its Hyperdocs subdomain or custom domain to confirm the update is live.
## What You Can Preview and Publish

| Page Type | What You See in Preview |
| --- | --- |
| Documentation | Pages and folders rendered with full formatting and your navigation structure. |
| Changelog | Dated entries in chronological order with their tags, colors, and icons. |
| Home Page | Your landing page with card-based blocks and applied branding. |
| Help Center | The hero section and content blocks as visitors will experience them. |

## Tips

- Preview after every significant change so you catch layout or formatting surprises early.
- Check both light and dark appearances if you've uploaded separate logos, so your branding looks right in each.
- Use the quick links on the dashboard to open the editor or jump straight to your live site.
> **TIP:** Preview is the safest way to review changes — nothing you see in preview is visible to the public until you publish.

> **INFO:** Your site is always available on its default Hyperdocs subdomain, even before you connect a custom domain.

## Troubleshooting

- If your changes don't appear on the live site, confirm you selected Publish after saving your edits in the editor.
- If the live site still shows old content, refresh the page in your browser, as cached versions can linger briefly.
- If your custom domain isn't serving the site, check that the domain connection has been verified in your domain settings.
- If branding such as logos or accent color looks wrong in preview, revisit your general settings and confirm your uploads were saved.
Related topics: Connect a Custom Domain, Configure Branding and General Settings, Edit the Home Page.

---

# Connecting a Custom Domain
Source: https://docs.hyperdocs.io/publishing-your-site/connecting-a-custom-domain

# 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.

## How It Works

- Your site is always available on a default Hyperdocs subdomain, so it stays live even before you add a custom domain.
- You can connect a custom subdomain, such as docs.yourcompany.com, to point readers to your own address.
- After adding a domain, Hyperdocs walks you through verifying ownership and connection status.
- You can monitor whether the domain is pending, verified, or fully connected directly from your settings.
- Once connected, all your published docs, changelog, and home pages are served automatically on the new domain.
## Steps

1. Open your admin dashboard and go to the Domain settings section.
1. Enter the custom subdomain you want to use, for example docs.yourcompany.com.
1. Save the subdomain to begin the connection process.
1. Add the DNS records shown by Hyperdocs to your domain provider to point the subdomain to your site.
1. Return to the Domain settings and check the connection status until it shows as verified.
1. Once verified, publish your site to make it available on your custom domain.
## Domain Connection Status

| Status | What It Means |
| --- | --- |
| Default subdomain | Your site is live on the built-in Hyperdocs subdomain with no setup required. |
| Pending verification | You have added a custom subdomain, but DNS records have not yet been confirmed. |
| Verified | DNS records are confirmed and your domain is ready to serve docs. |
| Connected | Your published site is live on your custom domain. |

## Tips

- Use a clear, memorable subdomain like docs or help so readers can easily guess and remember your documentation address.
- DNS changes can take time to spread across the internet, so wait a little while before assuming the connection failed.
- Keep your default Hyperdocs subdomain in mind as a reliable fallback while you finish setting up the custom domain.
> **INFO:** Your site remains fully accessible on the default Hyperdocs subdomain at all times, even while a custom domain is still verifying.

> **TIP:** Double-check that the DNS records you copy into your domain provider exactly match the ones shown in Hyperdocs to avoid delays.

## Troubleshooting

- If your domain stays in pending verification, confirm the DNS records were added correctly at your domain provider and saved.
- If the verified domain does not show your latest content, make sure you have published the site after connecting it.
- If you mistyped the subdomain, remove it from Domain settings and add the correct address again.
- If readers reach an error page, verify the connection status is showing as connected before sharing the link.
Related topics: Configure Branding and General Settings, Preview and Publish the Site, View Dashboard Overview.

---

# Answer Agent
Source: https://docs.hyperdocs.io/answer-agent/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.

## How It Works

When Answer Agent is enabled, a chat bubble appears on every public-facing page of your documentation site. Visitors can open the bubble, type a question, and receive an AI-generated answer drawn from your published docs. The widget tracks each conversation session and, when feedback is enabled, shows thumbs up/down controls after an answer so visitors can rate the response.

The widget is hidden on admin and login routes — it only appears on your public documentation pages. Each visitor is assigned a persistent anonymous ID so session duration and engagement can be measured in analytics.

## Configuring Answer Agent

Open the admin dashboard and navigate to **Answer Agent** in the sidebar. The configuration panel has three tabs: **Settings**, **Feedback section**, and **Customization**.

### Settings Tab

The Settings tab controls the core behavior of the widget.

**Enabled toggle** — turns the chat bubble on or off across your entire public site. When off, the widget does not appear for any visitor.

**No-answer message** — the text shown to a visitor when the agent cannot find a relevant answer. The default reads: *"I'm not entirely sure what you mean by "{query}." Could you provide a bit more context?"* You can replace this with any message that fits your tone.

**Contact email** — an email address shown below the no-answer message so visitors can reach your team directly.

**Contact link** and **Contact label** — a URL and its display label shown as a follow-up link when the agent cannot answer. The default label is *"For further help, contact"*.

**Visit link** and **Visit label** — a secondary URL and label for directing visitors to an external resource. The default label is *"For more details, visit"*.

### Feedback Section Tab

The Feedback section tab controls whether visitors can rate answers and what reason options they see.

**Feedback enabled toggle** — when on, a thumbs up / thumbs down bar appears below each answered response in the widget.

**Positive feedback options** — the selectable reasons a visitor can pick after a thumbs up. The defaults are *Helpful*, *Got what I needed*, and *Clear and accurate*. You can add, edit, or remove options.

**Negative feedback options** — the selectable reasons a visitor can pick after a thumbs down. The defaults are *Not relevant*, *Incorrect or misleading*, and *Confusing or unclear*. You can add, edit, or remove options.

### Customization Tab

The Customization tab lets you change how the widget looks and identifies itself to visitors.

**Agent name** — the display name shown inside the chat widget. Defaults to *Hyperdocs AI*.

**Bubble icon** — a custom image shown on the chat bubble button. If left empty, the default Hyperdocs favicon is used. You can upload a replacement image.

## Suggested Questions

You can configure a list of suggested questions that appear in the widget before a visitor types anything. These act as starter prompts to help visitors discover what they can ask. The defaults are *How do I get started?*, *What features are available?*, and *Show me the setup guide*. You can replace these with questions relevant to your product.

## The Chat Widget (Visitor Experience)

From a visitor's perspective, the widget appears as a bubble in the corner of your documentation pages. Clicking it opens a chat panel where they can:

- Type a question and receive an AI-generated answer from your documentation.
- Choose from suggested questions if they are not sure what to ask.
- Rate an answer with thumbs up or thumbs down (when feedback is enabled) and select a reason from the options you configured.
- See a contact link or visit link when the agent cannot find an answer, so they always have a fallback path to support.
- Close the panel at any time using the close button.
## Steps to Enable Answer Agent

- Open the admin dashboard and select **Answer Agent** from the sidebar.
- On the **Settings** tab, turn on the **Enabled** toggle.
- Set your **no-answer message**, **contact email**, **contact link**, and **visit link** so visitors always have a fallback when the agent cannot answer.
- Switch to the **Feedback section** tab and turn on **Feedback enabled** if you want visitors to rate answers. Review or edit the positive and negative reason options.
- Switch to the **Customization** tab and set the **agent name** and optionally upload a **bubble icon**.
- Add or edit **suggested questions** on the Settings tab to help visitors know what to ask.
- Click **Save Changes** to apply your configuration. The widget becomes active on your live documentation site immediately.
- To review how visitors are using the widget, go to **Analytics → Answer Agent** in the admin dashboard.

---

# Answer Agent Analytics
Source: https://docs.hyperdocs.io/answer-agent/answer-agent-analytics

# Answer Agent Analytics

Answer Agent has a dedicated analytics page in the admin dashboard at **Analytics → Answer Agent**. It is split into two tabs: **Engagement** and **Feedback**.

### Engagement Tab

The Engagement tab shows how visitors are interacting with the chat widget over a selected time range. You can filter by **Today**, **Last 7 days**, **Last 30 days**, or **Last year**.

The overview band displays the following metrics:

- **Opens** — how many times visitors opened the chat bubble.
- **Conversations** — the number of distinct chat sessions started.
- **Messages** — the total number of messages sent across all conversations.
- **Avg. duration** — the average length of a chat session, shown in a compact format such as *2m 30s* or *45s*.
- **Engagement rate** — the share of bubble opens that led to an actual conversation.
Below the overview band, the **Searched topics** table lists every topic visitors have asked about, with a total count badge. You can search topics by keyword and page through results. Expanding a row reveals the page breakdown and the last ten real questions asked under that topic.

### Feedback Tab

The Feedback tab shows how visitors rated the answers they received. The overview band displays:

- **Total responses** — the number of answers that received a thumbs up or thumbs down.
- **Positive count** and **positive percentage** — how many responses were rated positively.
- **Negative count** and **negative percentage** — how many responses were rated negatively.
- **Topic count** — the number of distinct topics that received feedback.
A **Responses over time** chart plots positive and negative feedback as two areas across the selected date range, so you can see trends at a glance.

The **feedback responses table** lists individual rated answers as cards. Each card shows the visitor's question, the sentiment (positive or negative), the selected reason label, the topic it was classified under, and the date. If the visitor left a written comment, it appears in a highlighted block on the card. You can filter the table by **All**, **Positive**, or **Negative** sentiment, and search by keyword.

##

---

# Sample
Source: https://docs.hyperdocs.io/answer-agent/sample

# Sample

Welcome to the Sample section.

---