Skip to content

docs: migrate Mintlify to Holocron on Cloudflare - #1742

Open
Dhravya wants to merge 5 commits into
mainfrom
capy/migrate-mintlify-to-holocron
Open

Dhravya wants to merge 5 commits into
mainfrom
capy/migrate-mintlify-to-holocron

Conversation

@Dhravya

@Dhravya Dhravya commented Oct 2, 2026 •

Copy link
Copy Markdown
Member

Replace Mintlify with a self-hosted Holocron Cloudflare Worker at /docs/, preserving the existing documentation navigation, artwork, authored content and interactive entry points.

Site compatibility

  • Restore the original tabs, nested anchors and sidebar groups, SVG strokes and brand icons, typography, homepage artwork, authored cards, raw-image behavior and light/dark themes. Fix mobile drawer/theme-menu layering and nested table-of-contents indentation.
  • Preserve all 146 published page URLs and 142 redirects. The public inventory contains 147 pages, including LiveKit. Keep same-origin HTTP and RSC redirects relative for reverse proxies and embedded previews.
  • Keep local title/heading search and add lazy public-body search at /docs/search-index.json, with keyboard shortcuts and title-search fallback when the download fails.
  • Render local page-specific social images using the original artwork and licensed Geist fonts instead of Holocron's hosted OG service.
  • Carry renderer compatibility in a pinned Bun patch for Holocron 0.36.0. Bun 1.4.2 or newer is required for its nested files; future renderer upgrades must revalidate this patch.

Interactive documentation

  • Restore the browser-side API playground: server selection, transient authentication, path/query/body inputs, multipart uploads, extra headers, SDK/cURL examples and response display. Credentials go only to the selected API server, are cleared on close/server changes, and are redacted from echoed responses and errors.
  • Preserve the header assistant, inline question box, page actions, code prompts and conversation drawer instead of adding a standalone assistant page. Answers retrieve documentation chunks from a dedicated Supermemory project and use Workers AI with canonical citations; questions and conversations are not stored as memories.
  • Preserve Markdown copying, contextual editor/MCP actions and the stateless public documentation MCP endpoint. Helpfulness votes record only a public page path and yes/no value in Analytics Engine.
  • Bound recursive schema expansion in the displayed reference while serving the complete recursive specification at /docs/openapi.json.

Deployment

The workflow validates PRs and deploys/indexes main only when DOCS_CLOUDFLARE_ENABLED=true. Indexing uses SuperRAG, deterministic IDs, content hashes, replacement updates and processing checks; deletion occurs only after successful reconciliation. The direct fetch URL is separate from the canonical citation URL.

flowchart LR
  Main[Docs push to main] --> Build[Validate and build]
  Build --> Deploy[Cloudflare Worker]
  Deploy --> Exports[Public Markdown exports]
  Exports --> Index[Reconcile SuperRAG index]
  Index --> SM[Dedicated docs project]
  Reader[Assistant or MCP request] --> Retrieve[Retrieve docs chunks]
  SM --> Retrieve
  Retrieve --> Answer[Workers AI answer and citations]
Loading

No public DNS or routes have been changed. Keep Mintlify live until the direct Worker is verified, then switch only the existing /docs/* route. Retire the legacy Mintlify repository build/link checks and replace required checks with the docs build job before merging.

The API playground requires the exact canonical-origin allowance in mono#3397 to be deployed before cutover. Its Cloudflare preview currently fails with Script startup exceeded CPU time limit; local CORS probes do not establish production deployment.

Verification

  • Fresh patched-package reinstall with bun install --frozen-lockfile reproduces source and dist byte-for-byte. Docs check-types, build, scoped Biome checks and Worker deploy --dry-run pass.
  • 279 existing renderer/navigation/OpenAPI tests pass, plus scratch-only request, header-redaction, chat and feedback probes. No test files or snapshots are changed by this PR or included in the dependency patch.
  • The built Worker serves all 147 HTML/Markdown pages, covers all 146 legacy URLs and preserves 142 redirects. MCP discovery/resources, recursive OpenAPI export and indexing dry run pass.
  • Browser checks prove desktop/mobile rendering, theme switching, the API playground and body-only search: “promoted” finds Quickstart. Blocking the public index still returns navigable title results.

Not yet verified: live Cloudflare deployment, actual Supermemory ingestion/Workers AI answers, production feedback events and playground requests from the canonical website. These require deployment access, a dedicated documentation-project key, and the API CORS deployment. Setup and cutover instructions are in apps/docs/README.md.

Preview

Original-style desktop homepage

Mobile API playground

Public body search

@mintlify

mintlify Bot commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
supermemory 🔴 Failed – Oct 2, 2026, 12:27 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
✅ Deployment successful!
View logs
supermemory-mcp 671be04 Oct 02 2026, 06:16 AM

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
supermemory-app 671be04 Commit Preview URL

Branch Preview URL
Oct 02 2026, 06:17 AM

@socket-security

socket-security Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant