Skip to content

Migrate the docs to the docs.dev template - #4

Open
avb-dev-docs wants to merge 1 commit into
mainfrom
claude/docs-template-parity-fd5zj6
Open

avb-dev-docs wants to merge 1 commit into
mainfrom
claude/docs-template-parity-fd5zj6

Conversation

@avb-dev-docs

Copy link
Copy Markdown

What

Replaces the Mintlify starter scaffold with our own docs.dev template, so the Keyboard docs get every feature we've been shipping in the template instead of lagging behind it:

  • the pretext reading experience and Fumadocs UI (search, sidebar, theme toggle)
  • the /admin in-site editor with review-before-publish shared drafts
  • Ask AI (Workers AI) + anonymous reader-question insights
  • agent-native routes: append .md to any page, /llms.txt, /llms-full.txt, and the /mcp endpoint
  • OG image generation, OpenAPI reference generation (placeholder until we add a spec)
  • CLAUDE.md + /new-page and /draft-page skills so coding agents are productive here out of the box
  • push-to-deploy via Cloudflare Workers Builds (wrangler.jsonc, worker name keyboard-docs)

Content

All nine Mintlify pages are ported 1:1 into content/docs/ with the same group structure (Getting started / Guides / How it works). Mintlify components are mapped to Fumadocs equivalents (Info/Tip/Note → Callout, AccordionGroup → Accordions, Mintlify Tabs → Fumadocs Tabs), images moved to public/images/, and cross-page links converted to site-relative /docs/... paths (this also fixes a few links that already pointed at nonexistent paths). guides/app_builder is renamed to guides/app-builder to satisfy the template's kebab-case slug rule; one typo fixed ("vonnections").

Branding & URLs

  • Keyboard logo (light/dark), favicon, and "Keyboard Docs" page titles; landing copy rewritten for Keyboard
  • / redirects to /docs (HOME_REDIRECT_TO_DOCS=true) since keyboard.dev is the marketing site — flip the var in wrangler.jsonc to serve the landing page instead
  • worker.js permanently redirects the old Mintlify-era URLs (/getting-started/…, /guides/…, /how-it-works/…) to their /docs/… equivalents so existing inbound links keep working

Verification

  • pnpm types:check and pnpm lint pass
  • All nine pages + landing render in pnpm dev (checked markers and screenshots: sidebar groups, tabs, callouts, accordions, theme-aware architecture SVGs and logo)
  • /llms.txt and .md routes serve the ported content

Deploy notes (post-merge)

This changes hosting from Mintlify to Cloudflare Workers: the repo needs to be connected to Workers Builds and the docs.keyboard.dev DNS pointed at the Worker before/when merging. Requires the Workers Paid plan (bundle > 1 MiB). Secrets (GITHUB_PAT or team sign-in via DOCSDEV_SITE_TOKEN, ADMIN_PIN/ADMIN_SECRET) are only needed for the /admin editor.

🤖 Generated with Claude Code

https://claude.ai/code/session_014t4t29GCH4iWKUcgJHKN8T


Generated by Claude Code

Replace the Mintlify starter scaffold with the docs.dev template
(Fumadocs + pretext + Cloudflare Workers) so these docs get all the
features we ship in the template: the pretext reading experience, the
/admin editor with review-before-publish drafts, Ask AI, .md/llms.txt
agent routes, the OG/MCP endpoints, and push-to-deploy Workers Builds.

Content is ported 1:1 from the Mintlify pages into content/docs/
(Mintlify components mapped to Fumadocs equivalents), with sidebar
groups mirroring the old docs.json navigation. Keyboard branding
replaces docs.dev branding (logo, titles, favicon, landing copy), /
redirects to /docs since keyboard.dev is the marketing site, and
worker.js 308-redirects the old Mintlify-era URLs to their /docs
equivalents so existing links keep working.

Co-Authored-By: Claude Fable 5 <[email protected]>
Claude-Session: https://claude.ai/code/session_014t4t29GCH4iWKUcgJHKN8T
@avb-is-me
avb-is-me marked this pull request as ready for review July 20, 2026 13:42

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.

2 participants