Navigating the Admin Dashboard

The Hyperdocs admin dashboard is the control center for your entire documentation workspace. Every tool — from writing pages to publishing changelogs, running audits, and configuring SEO — is reachable from a persistent sidebar on the left. This page explains what each section is and where it lives so you can move around the admin confidently.

The Admin Layout

The admin interface has two persistent elements that are always visible regardless of which section you are in:

Sidebar Navigation Map

The table below lists every section in the sidebar, the route it opens, and what you do there.

| Sidebar item | Route | What you do here | |---|---|---| | Dashboard | `/admin/dashboard` | Your workspace home. See recent activity and quick links. | | Editor | `/admin/editor` | Write, organize, and publish documentation pages and folders. | | Home | `/admin/home` | Edit the landing page visitors see when they arrive at your docs site. | | Help Center | `/admin/help-center` | Edit the help center hero, content blocks, and enable or disable the page. | | Changelog | `/admin/changelog` | Add, edit, and publish dated changelog entries with tags. | | API Reference | `/admin/api-reference` | Build and publish a structured public API reference. | | Git Sync | `/admin/git-sync` | Connect a GitHub repository, review pending commits, and generate docs. | | Docs Audit | `/admin/docs-audit` | Scan your codebase against your docs and get a documentation health score. | | Analytics | `/admin/analytics` | View page views, unique visitors, and top pages across your site. | | Marketing → SEO | `Marketing` group | Set site-wide meta title, description, OG image, scripts, CSS, and robots.txt. | | Marketing → Meta Tags | `Marketing` group | Generate and manage per-page meta titles and descriptions with AI. | | Settings → Multilingual | `Settings` group | Translate your docs into additional languages and manage published locales. | | Settings → Domain | `Settings` group | Connect a custom domain to your documentation site. | | Settings → General Settings | `Settings` group | Set your organization name, accent color, logos, favicon, and branding. | | Settings → Account | `Settings` group | View your sign-in details, update your profile, and sign out. | | Upgrade / Billing | `Settings` group | View your current plan, upgrade, and manage add-ons. |

Dashboard

The Dashboard at `/admin/dashboard` is the first screen you land on after signing in. It shows a personalized greeting, recent activity across your workspace, and quick links to open the editor or view your live site. If you have not yet chosen a starting point for your documentation, the dashboard prompts you to do so before other sections become fully active.

Editor

The Editor at `/admin/editor` is where you write and organize your documentation. The left sidebar inside the editor shows your page and folder tree. Clicking a page opens it in the block editor in the main panel. A right-hand settings panel lets you manage per-page SEO metadata and sharing options for the page you have open.

The editor top bar includes a language switcher that lets you switch between English (the source) and any translated locale you have set up. When a non-English locale is selected, the editor shows the translated copy of the page rather than the English source.

Home, Help Center, and Changelog

These three sections each open a dedicated editor for a specific part of your public site:

API Reference

The API Reference section lets you build a structured, public-facing API reference inside Hyperdocs. The header contains Edit and Preview buttons to switch between building mode and a rendered preview, plus an Enabled / Disabled toggle that controls whether the API Reference tab appears on your public site.

Git Sync

Git Sync (`/admin/git-sync`) connects your GitHub repository to Hyperdocs. From here you can check for pending commits, analyze changes with AI, generate documentation from your codebase, and configure sync settings such as the email digest. If no repository is connected, this screen shows the GitHub connection flow.

Docs Audit

Docs Audit (`/admin/docs-audit`) scans your connected GitHub repository against your published documentation and produces a documentation health score, a list of undocumented areas, and a list of outdated claims. The left sidebar on this screen lists your audit history so you can load any past run.

Analytics

The Analytics section (`/admin/analytics`) shows page view data for your published site. It has two tabs — Overview and Pages — and a set of range filters (Today, Last 7 days, Last 30 days, Last 90 days, Last year). A content-type filter lets you narrow data to All, Documentation, Changelog, API Docs, or Help Center.

Marketing

The Marketing group in the sidebar contains two screens:

Settings

The Settings group contains four screens:

Top Bar Controls

The top bar is present on every admin screen and contains three controls:

Role-Based Access

Your workspace role controls what you can do in each section. Three roles exist: Admin, Editor, and Viewer.

| Section | Admin | Editor | Viewer | |---|---|---|---| | Editor — read content | ✓ | ✓ | ✓ | | Editor — create, edit, delete pages | ✓ | ✓ | — | | Home / Help Center / Changelog — edit and save | ✓ | ✓ | — | | API Reference — edit content and toggle visibility | ✓ | ✓ | — | | API Reference — toggle global Enabled / Disabled | ✓ | — | — | | Git Sync — connect repo, generate docs | ✓ | — | — | | Docs Audit — run audits, configure schedule | ✓ | — | — | | Analytics — view data | ✓ | ✓ | ✓ | | Marketing / SEO — save changes | ✓ | — | — | | Meta Tags — generate and save | ✓ | — | — | | Multilingual — translate and publish | ✓ | ✓ | — | | General Settings — save changes | ✓ | — | — | | Upgrade / Billing — manage plan | ✓ | — | — |

Docs Agent

The Docs Agent is accessible from within the editor workflow. It includes an About Company panel where you provide context about your product — a company website URL and a free-text description — that the agent uses when drafting documentation. Admins and Editors can save and generate content here; Viewers can read but not save.