feat: Mintlify docs migration#1118
Merged
Merged
Conversation
Migrate all 618 GitBook markdown files to Mintlify MDX format: - Convert GitBook syntax (tabs, hints, embeds, card tables, code blocks) to Mintlify components - Generate docs.json with full navigation structure (8 tabs, 44 groups) - Copy 586 assets from .gitbook/assets/ to images/ - Add favicon and light/dark logo - Include migration script for reproducibility Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Migrate all 608 GitBook markdown files across 3 spaces (api-reference, brand-guides, guides) to Mintlify MDX format: - Convert GitBook syntax (tabs, hints, embeds, card tables, code blocks) - Self-close void HTML elements (br, img, hr) for MDX compatibility - Convert HTML comments to MDX comments - Generate docs.json with full navigation structure - Copy 624 assets to images/ - Add favicon and light/dark logo Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The migration script now downloads favicon and logos from GitBook CDN automatically, so they don't need to be fetched manually after running. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The script now produces all files needed for mintlify dev: docs.json, package.json, logos, favicon, and all content. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Store favicon and logos in branding/ directory. The migration script copies them into mintlify-docs/images/ — no network calls needed. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Branding assets (favicon, logos) now live in mintlify-docs/images/ where Mintlify expects them. The migration script preserves these files when cleaning generated content. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Rewrite SUMMARY.md parser to produce correct Mintlify navigation: - Guides tab with sidebar groups (Getting Started, Use Cases, Core Concepts, etc.) - API Reference tab with groups per resource (Access Codes, Devices, etc.) - Brand Guides tab with groups per manufacturer Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Maps all old docs.seam.co/latest/ paths to new Mintlify structure: - /latest/* strips the prefix - /api/* → /api-reference/* - /device-and-system-integration-guides/* → /brand-guides/* - /core-concepts/*, /capability-guides/*, etc. → /guides/* - /products/* → /guides/capability-guides/* Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Output files now match old GitBook URL structure exactly: - guides/ content → root (quickstart, core-concepts/*, etc.) - api-reference/ content → api/ (api/access_codes/create, etc.) - brand-guides/ content → device-and-system-integration-guides/ No redirects needed — all old docs.seam.co/latest/* links work as-is. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Rename README.mdx → index.mdx (127 files) so Mintlify serves directory pages at clean paths like /core-concepts/devices instead of /core-concepts/devices/README. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The Format Code CI job was reformatting an mdx file, pushing a commit, which triggered another CI run, creating an infinite loop. Generated docs content should be ignored by prettier like the docs/ folder. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
<Tabs>,<Info>,<CardGroup>, etc.)<br>,<img>,<hr>) for MDX compatibilitydocs.jsonwith 3-tab navigation matching the live site: Guides | API Reference | Brand Guidesmigrate-to-mintlify.mjs) for reproducibilityWhat's in
mintlify-docs/docs.json— Mintlify config with navigation, branding, colorspackage.json—npm install && npx mintlify devto preview locallyimages/— all assets + favicon + logos.mdxcontent files matching old URL pathsTo preview locally
Remaining polish (non-blocking)
<source>/<picture>tags, curly braces in content)Could not parse expression with acornerrors from literal{in prose🤖 Generated with Claude Code