Dashboard Overview
Navigate the HolyDocs dashboard to manage your documentation projects, deployments, and settings.
Overview
The HolyDocs dashboard at app.holydocs.com is your command center for creating, configuring, and managing documentation projects. From here you can trigger deployments, edit content, review analytics, and configure every aspect of your documentation site.
First-Time Experience
When you sign in for the first time, HolyDocs walks you through onboarding to get your first project live in under two minutes.
Create your account
Sign up with GitHub, GitLab, or email at app.holydocs.com/onboarding. GitHub and GitLab sign-ups automatically connect your repository provider for later use.
Create your first project
Give your project a name and slug. The slug determines your default subdomain — for example, a slug of acme-docs gives you acme-docs.holydocs.com.
Connect a repository
Select a GitHub or GitLab repository that contains your documentation files. Choose the branch and the directory path where your MDX files live (defaults to /docs).
First deployment
HolyDocs triggers an initial build. Within seconds your documentation is live on your subdomain. You can add a custom domain later in Settings.
If you do not have a repository ready, HolyDocs can scaffold a starter project with example pages and a pre-configured docs.json. Select Start from template during onboarding.
Dashboard Layout
The dashboard uses a sidebar navigation pattern. The sidebar is always visible on the left and provides access to every section of your project.
Sidebar Navigation
The sidebar is divided into two groups:
Core pages:
| Item | Purpose |
|---|---|
| Overview | Project summary, recent deployments, quick stats, and the Deploy button |
| Deployments | Full deployment history with statuses, logs, and commit details |
| Analytics | Page views, search queries, feedback scores, and AI assistant usage |
| Editor | Visual and code editors for writing documentation in the browser |
Manage section:
| Item | Purpose |
|---|---|
| Changelog | Publish updates about your product or documentation changes |
| Roadmap | Share planned features and collect user votes |
| Feedback | Review per-page reader feedback and satisfaction scores |
| Integrations | Connect third-party services like Slack, Discord, and analytics providers |
| Settings | Configure project name, appearance, domains, Git, SEO, auth, and more |
Project Overview Page
The Overview page is the first thing you see when you open a project. It provides a snapshot of your documentation health and quick access to common actions.
What You Will See
- Deploy button — Trigger a manual deployment without pushing to Git
- Recent deployments — The last five deployments with status badges (success, failed, building)
- Quick stats — Page views over the last 7 days, total pages, and the number of indexed search entries
- Project URL — Your live documentation URL with a copy button
- Last commit — The commit SHA, message, and timestamp of the most recent deployment
The quick stats panel refreshes automatically every 60 seconds while the Overview page is open. You do not need to reload the page to see updated numbers.
Organization Management
Organizations let teams collaborate on documentation projects with shared billing and access control.
Creating an Organization
Navigate to the organization switcher in the top-left of the sidebar and select Create organization. Provide a name, invite team members by email, and choose a billing plan.
Roles
| Role | Permissions |
|---|---|
| Owner | Full access, billing, can delete the organization |
| Admin | Manage projects, members, and settings (cannot delete the organization) |
| Member | Edit content, trigger deployments, view analytics |
| Viewer | Read-only access to analytics and deployment logs |
Transferring Projects
Projects can be transferred between organizations or to your personal account. Go to Settings > Advanced in the project and select Transfer project. You must be an Owner or Admin in both the source and destination organizations.
Creating a New Project
You can create additional projects at any time:
Open the project switcher
Click the project name in the sidebar header to open the project dropdown.
Select Create new project
Click New project at the bottom of the dropdown list.
Configure the project
Enter a project name, slug, and connect a Git repository. You can also choose to start from a template or import from another documentation platform (Mintlify, GitBook, Docusaurus).
Deploy
HolyDocs triggers the first build automatically. Your docs are live within seconds.
Switching Between Projects
Use the project switcher dropdown in the sidebar header to switch between projects. Projects are grouped by organization. The dropdown also includes a search field for fast lookup when you have many projects.
Use the keyboard shortcut Cmd+K (Mac) or Ctrl+K (Windows/Linux) to open the command palette, then type a project name to switch instantly.
User Profile and Account Settings
Click your avatar in the bottom-left of the sidebar to access account settings.
Profile Settings
- Display name and avatar — Shown in team activity and changelog author fields
- Email — Your primary email for notifications and billing receipts
- Connected accounts — Link or unlink GitHub and GitLab accounts
Notification Preferences
Control which events send email notifications:
- Deployment failures
- New feedback received
- Roadmap vote milestones
- Team member invitations
- Weekly analytics digests
API Keys
Generate personal API keys for use with the HolyDocs REST API and CLI. Each key can be scoped to specific projects and has a configurable expiry.
API keys grant access to your projects. Never commit them to a repository or share them in public channels. Rotate keys immediately if you suspect they have been compromised.
Keyboard Shortcuts
The dashboard supports keyboard shortcuts for power users. Press ? on any page to see the full shortcut reference.
| Shortcut | Action |
|---|---|
| Cmd+K / Ctrl+K | Open command palette |
| Cmd+S / Ctrl+S | Save current editor content |
| Cmd+Shift+D / Ctrl+Shift+D | Trigger a deployment |
| Cmd+B / Ctrl+B | Toggle sidebar visibility |
| Cmd+/ / Ctrl+/ | Open keyboard shortcut reference |
| G then O | Go to Overview |
| G then D | Go to Deployments |
| G then A | Go to Analytics |
| G then E | Go to Editor |
| G then S | Go to Settings |
Sequential shortcuts (like G then O) must be pressed within 500ms of each other. The first keypress activates a "go to" mode indicator in the bottom-right corner of the screen.