FAQ

HolyDocs is an AI-native documentation platform built on Cloudflare. It lets developer teams write documentation in MDX, deploy it to a global edge network, and enhance it with AI-powered search, an embedded chat assistant, an MCP server, and an autonomous documentation agent.

You write content in MDX files, configure your site with a single docs.json file, connect a GitHub or GitLab repository, and push to deploy. HolyDocs handles rendering, hosting, CDN caching, search indexing, and AI features automatically.

HolyDocs was built as a Mintlify alternative with several key differences:

• Performance: HolyDocs renders on Cloudflare Workers (300+ edge locations) with sub-50ms TTFB globally, compared to Mintlify's single-region Vercel deployment
• AI features: Built-in agentic RAG assistant with tool calling, MCP server for IDE integration, autonomous doc maintenance agent, and AI-powered translation
• Compatibility: HolyDocs is fully compatible with Mintlify projects. You can migrate in under 5 minutes with holydocs migrate --from mintlify
• Pricing: Lower price points across all tiers with no overage charges
• llms.txt: Automatic generation of AI-readable documentation files on every build

The HolyDocs CLI and select client libraries are open source. The platform itself (API, renderer, dashboard) is a hosted service. Enterprise customers can request a self-hosted deployment for regulated environments.

HolyDocs has five plan tiers:

Annual billing saves approximately 17%. See the Plans & Pricing page for a full feature comparison.

Yes. The Free plan includes 1 project with up to 50 pages, 10 builds per day, edge rendering, keyword search, Git integration, and a default subdomain. No credit card is required to get started.

Yes. Every new account starts with a 14-day Pro trial, giving you access to all Pro features including the AI assistant, semantic search, preview deployments, and custom CSS. No credit card required. After the trial, you can continue on the Free plan or upgrade.

Yes. Open-source projects with a public GitHub repository can apply for a free Pro plan. Contact support with a link to your repository.

Yes. HolyDocs has full migration support for Mintlify projects. Run holydocs migrate --from mintlify from your project directory to automatically convert your mint.json configuration and MDX components. Most projects require zero manual changes.

See the Migrating from Mintlify guide for step-by-step instructions.

Yes. The CLI supports migration from both platforms:

bash
holydocs migrate --from gitbookholydocs migrate --from docusaurus

GitBook migration converts SUMMARY.md navigation and hint blocks. Docusaurus migration converts sidebars.js, admonitions, and config files. See the migration guides for GitBook and Docusaurus.

The CLI supports ReadMe (--from readme) and VuePress (--from vuepress) migrations. For other platforms, you can manually create a docs.json configuration and write your content in MDX. The installation guide covers setting up a new project from scratch.

Yes. After setting up your HolyDocs project, update your DNS CNAME to point to proxy.holydocs.com instead of your previous provider. SSL is automatically provisioned. Consider lowering your DNS TTL before the switch to minimize transition time.

HolyDocs serves every page from Cloudflare's edge network with 300+ points of presence worldwide. Pages are pre-rendered and cached in Cloudflare KV, resulting in sub-50ms Time to First Byte (TTFB) for readers anywhere in the world. There is no origin server round-trip -- content is served directly from the PoP nearest to the reader.

Yes. You can configure a custom domain like docs.yourcompany.com with automatic SSL certificate provisioning. The number of custom domains varies by plan (0 on Free, 1 on Starter, 5 on Pro, 20 on Business, unlimited on Enterprise). See the Custom Domains documentation for setup instructions.

Yes. Subfolder hosting lets your documentation live at yoursite.com/docs instead of a separate subdomain. This requires configuring a basePath in your project settings and setting up a reverse proxy on your main web server. Available on Starter plans and above. See the Subfolder Hosting guide.

HolyDocs runs on Cloudflare Workers, which has a 99.99% uptime track record. Enterprise plans include a contractual SLA with financial credits for downtime. Standard plans do not have a formal SLA but benefit from the same infrastructure.

The AI assistant uses Retrieval-Augmented Generation (RAG) to answer reader questions. After each deployment, your documentation is chunked into semantic segments and embedded into a vector index (Cloudflare Vectorize). When a reader asks a question, the assistant:

1. Converts the query into a vector embedding
2. Performs hybrid search (semantic + keyword) to find relevant content
3. Uses tool calling to retrieve specific pages if needed
4. Generates a response grounded in your actual documentation
5. Streams the answer with source citations

The assistant is available on Pro plans and above. See AI Assistant for configuration details.

Every HolyDocs project with a Starter plan or above gets an MCP (Model Context Protocol) server. This allows AI-powered IDEs like Claude Code, Cursor, and Windsurf to search and read your documentation directly. Developers can ask questions about your API or SDK without leaving their editor.

The MCP server exposes three tools: search_docs, get_page, and list_pages. See MCP Server for setup instructions.

Yes. HolyDocs publishes a public skills repository for AI coding assistants at seangeng/holydocs-skills.

Install everything with:

bash
npx skills add seangeng/holydocs-skills

Or install a specific skill:

bash
npx skills add seangeng/holydocs-skills --skill holydocs

See Agent Skills for the full list and install options.

The AI agent is an autonomous system that monitors your documentation and performs maintenance tasks. It can detect outdated content, suggest improvements, fix broken links, and generate missing pages. Agent jobs run on a schedule or can be triggered manually from the dashboard. Available on Business and Enterprise plans. See AI Agent for details.

AI translation is available on Business and Enterprise plans. Supported languages include English, Spanish, French, German, Portuguese, Italian, Dutch, Russian, Chinese (Simplified), Chinese (Traditional), Japanese, Korean, Arabic, Hindi, Turkish, Polish, Swedish, Norwegian, Danish, Finnish, Czech, Thai, Vietnamese, and Indonesian. Business plans support up to 10 languages; Enterprise supports all 24. See Internationalization for details.

Yes, in several ways:

• Themes: Choose from 11 built-in themes (mint, maple, palm, willow, linden, almond, aspen, holy, atlas, nova, cipher)
• Colors: Set primary, background, and accent colors in docs.json
• Custom CSS: Write custom CSS to override any aspect of the design (Pro plans and above)
• Dark mode: Full dark mode support on all themes
• Logo and favicon: Custom logo and favicon in docs.json

See Themes and Custom CSS for details.

HolyDocs supports documentation versioning to maintain docs for multiple versions of your product. Basic versioning uses directory-based version separation. Business and Enterprise plans support branch-based versioning where each Git branch represents a version. A version selector is displayed to readers automatically. See Versioning for details.

Yes. You can export your documentation in several formats:

• MDX source: Your content is always in your Git repository -- no vendor lock-in
• Static HTML: Download a static HTML archive from the dashboard
• PDF: Generate PDF exports of individual pages or the entire site
• Markdown: Export as plain Markdown (without components)

Export options are available under Settings > Exports in the dashboard.

Yes. HolyDocs works with monorepo setups (Turborepo, Nx, Lerna, etc.). Configure the docs subdirectory in Settings > Git by specifying the repoPath to your documentation directory. The build pipeline reads only from that subdirectory, and webhooks only trigger builds when files in that directory change.

For CI/CD, use path filters to trigger documentation deployments only when docs files change. See the CI/CD guide for monorepo-specific configuration.

When you open a pull request against your production branch, HolyDocs automatically creates a preview deployment with a unique URL (e.g., preview-abc123.holydocs.com). A comment is posted on the PR with the preview link. Reviewers can see the rendered documentation changes before merging. Preview deployments are updated on each push to the PR and cleaned up when the PR is closed.

Preview deployments are available on Pro plans and above. See Deployments for details.

When a deployment is triggered (via Git push, CLI, or API), HolyDocs runs the following pipeline:

1. Fetch: Clone the repository and read the docs directory
2. Parse: Validate docs.json and parse all MDX files
3. Process: Run the MDX pipeline (remark/rehype plugins), process images, generate code samples
4. OpenAPI: Parse OpenAPI specs and generate endpoint pages
5. Index: Chunk content, generate vector embeddings, build keyword index
6. Deploy: Upload rendered pages to R2/KV, purge CDN cache
7. Finalize: Generate sitemap, llms.txt, og:images, and agent card

Typical build times are 5-15 seconds for a 100-page site.

Yes. The holydocs CLI works in any CI/CD platform. Set the HOLYDOCS_API_KEY and HOLYDOCS_PROJECT environment variables and run holydocs deploy. The CI/CD Integration guide includes complete examples for GitHub Actions, GitLab CI, CircleCI, Bitbucket Pipelines, and Azure DevOps.

Yes. HolyDocs takes security seriously:

• All data is encrypted in transit (TLS 1.3) and at rest
• Git credentials use installation tokens that auto-refresh and are never stored long-term
• API keys can be scoped with granular permissions
• The platform runs entirely on Cloudflare's infrastructure with SOC 2 Type II certification
• Enterprise plans support SSO/SAML, audit logs, and single-tenant deployment

Yes. Business and Enterprise plans support SSO via SAML 2.0. This allows your team to authenticate using your company's identity provider (Okta, Azure AD, Google Workspace, OneLogin, Auth0, JumpCloud, etc.) for both the dashboard and protected documentation sites. See SSO/SAML for configuration details.

HolyDocs includes built-in, privacy-friendly analytics with no third-party scripts. Tracked metrics include page views (total and unique), search queries and click-through rates, time on page, referral sources, AI assistant usage, and reader feedback. The tracking script is under 2KB, does not use cookies, and respects Do Not Track settings. See Analytics for details.

Yes. You can restrict access to your documentation with password protection, SSO gating (Business and Enterprise), IP allowlisting (Enterprise), and seo.indexing: false to prevent search engine crawling. Private documentation sites are not accessible to the public and are excluded from all search indexes.

HolyDocs sends HTTP POST notifications to your server when events occur in your project. Supported events include deployment.started, deployment.completed, deployment.failed, page.created, page.updated, page.deleted, feedback.received, and assistant.conversation.completed. Each delivery includes an HMAC-SHA256 signature for verification. Configure webhooks in Settings > Webhooks or via the API. See Webhooks for the full event reference.

llms.txt is a standard for providing AI-readable versions of your website content. HolyDocs automatically generates llms.txt (summary) and llms-full.txt (full content) files on every build. These files help AI search engines like Perplexity and ChatGPT search discover and accurately cite your documentation. Additionally, HolyDocs generates a skill.md file and an agent-card.json for AI agent discovery. See llms.txt for details.