Skip to content

feat: finalize Mintlify migration — redirects, analytics, SEO, meta descriptions#1129

Merged
sybohy merged 3 commits into
mainfrom
feat/mintlify-migration-iteration
Jun 10, 2026
Merged

feat: finalize Mintlify migration — redirects, analytics, SEO, meta descriptions#1129
sybohy merged 3 commits into
mainfrom
feat/mintlify-migration-iteration

Conversation

@sybohy

@sybohy sybohy commented Jun 10, 2026

Copy link
Copy Markdown
Member

Brings the Mintlify docs to parity with GitBook ahead of the production cutover. Part of the Mintlify Docs Migration Linear project (DOC-193 → DOC-197).

What's in here

docs.json config

  • Redirects (DOC-195): +414 entries (42 → 456) so every legacy GitBook URL resolves — no 404s. Covers API resource index pages, guide relocations, and brand-guide path moves. Every destination was validated against real MDX routes, OpenAPI x-mint.href routes, and existing redirects (no dup sources, no shadowing of real pages).
  • Analytics (DOC-194): integrations block for GA4 + PostHog (US-cloud apiHost), values pulled from the docs Doppler project (PUBLIC_GA4_ID, PUBLIC_POSTHOG_KEY).
  • SEO (DOC-196): site-wide seo block — canonical metatags matched to the marketing site (og:site_name: Seam, twitter:site: @helloseam, summary_large_image), absolute og:image, indexing: navigable.

Content

  • Meta descriptions added to 119 pages — 74 hand-written guides + 45 API object/static reference pages (DOC-196 + DOC-197). Two factually-wrong descriptions fixed (Dormakaba pages that said "Latch").
  • Docs-specific Open Graph image (images/seam-og-default.jpg, 1200×630).

Verification done

  • docs.json is valid JSON; redirect set independently re-validated (all destinations resolve).
  • All 119 changed MDX files have parseable frontmatter with a description.
  • Logo/favicon (DOC-193) verified already-correct (light/dark convention).

Not covered here (pre-promotion gates)

  • Mintlify deploy-preview build + broken-link crawl — should run in CI on this PR. Static validation confirms redirect targets exist but only a real build catches in-page link / MDX issues.
  • Analytics event flow — verifiable only after deploy.
  • Domain cutover (docs.seam.co, dropping /latest) — operational, outside this repo.

🤖 Generated with Claude Code

…escriptions

Bring the Mintlify docs to parity with GitBook ahead of production cutover.

docs.json:
- Add 414 redirects (42 -> 456) so every legacy GitBook URL resolves with no
  404s. Covers API resource index pages, guide relocations, and brand-guide
  path moves. All destinations validated against real mdx/OpenAPI routes.
- Add analytics integrations (GA4 + PostHog, US-cloud host) from the `docs`
  Doppler project.
- Add site-wide seo block: canonical metatags matched to the marketing site
  (og:site_name Seam, twitter:site @helloseam, summary_large_image), absolute
  og:image, and indexing: navigable.

Content:
- Add unique meta descriptions to 119 pages (74 hand-written guides + 45 API
  object/static reference pages); fix 2 factually-wrong descriptions.
- Add docs-specific Open Graph image (images/seam-og-default.jpg, 1200x630).

Tracked in Linear: DOC-193..DOC-197 (Mintlify Docs Migration).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@sybohy sybohy requested a review from a team as a code owner June 10, 2026 04:23
@mintlify

mintlify Bot commented Jun 10, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
seam 🟢 Ready View Preview Jun 10, 2026, 4:27 AM

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

Ten agent-written descriptions used single-quoted YAML containing a literal
apostrophe (e.g. 'Seam's SDK'), which is invalid YAML and broke Mintlify's
MDX frontmatter parser. Switched those to double-quoted strings.

Verified: npm run validate:mintlify passes (exit 0); all 119 changed mdx
frontmatter parse cleanly with a YAML parser.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@sybohy sybohy merged commit bff4887 into main Jun 10, 2026
10 checks passed
@sybohy sybohy deleted the feat/mintlify-migration-iteration branch June 10, 2026 18:18
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