Skip to content

feat(docs): rebuild documentation with the shared Sim design system - #9459

Draft
emir-karabeg wants to merge 13 commits into
stagingfrom
feat/docs
Draft

emir-karabeg wants to merge 13 commits into
stagingfrom
feat/docs

Conversation

@emir-karabeg

@emir-karabeg emir-karabeg commented Oct 29, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Replaces Fumadocs with a Sim-owned Next.js docs site and a shared component library based on the shared Sim design system. One compiled catalog drives HTML, Markdown, navigation, search, metadata, JSON discovery and read-only MCP.

Preserves 495 authored documents, 308 API operations, existing routes and anchors, platform screenshots and product-owned generators. Rebased onto staging a0f47b1e87, including its Search documentation and screenshot updates. The compatibility inventory was independently refreshed from that staging commit; original migration evidence remains in Git history.

The root App Router layout keeps the navbar, sidebar, footer and search mounted across document navigation. Sidebar scroll survives opening Logs, nested pages and browser Back; the mobile menu restores its position after reopening. Pages supply only their own article and outline. Both scroll-reset regressions were reproduced before the fix.

Navigation uses stable header weights, single-owner sidebar hover, consistent group spacing and one shared anchor offset and active-section subscription, including final sections clamped by the viewport. The search palette has section-aware quick links, one close control and correct shortcut focus restoration. Shared rows, menus, segmented tabs, code panels, typography and logo geometry follow the shared Sim component system; header/footer links do not drag, and root overscroll is disabled.

Screenshots retain their original photographic backgrounds, proportional spacing, and overview/detail/result framing. The introduction restores the live hero crop on desktop and mobile. Inline images and the full-size viewer share one frame component. Expanded images retain their intrinsic proportions and rounded corners. The article fills the available reading width, and the outline aligns with the header’s primary action. All four backgrounds and the platform screenshot match the current live assets byte for byte. The layout and viewer regressions were reproduced before their fixes.

The shared dark theme now maps every reading and control role to the current Sim palette, including selected sidebar edges, underlined outline/prose links, visible selected tabs, action states, syntax highlighting and semantic badges. Search, media and workflow dialogs share one surface primitive; portals and native controls inherit the theme. Reduced-transparency preferences replace glass with opaque surfaces and remove blur. The regression failed before the fix and passes in the production browser suite.

Nested API tabs now reveal the correct ancestor panels for fragments and browser find. CI generates the page registry before import audits, and the PostgreSQL test command supplies its required server-only condition. Normal builds no longer regenerate historical migration reports.

Review size

Approximately 97% of added lines are generated migration inventories and verification evidence, now marked as generated for GitHub review. Application code plus compiler/tooling grew by roughly 500 lines net. Removed Fumadocs library implementations lived in installed dependencies and therefore do not appear as source deletions.

Validation

  • Production build and explicit migration verification pass: no lost routes, anchors or changed code examples.
  • Latest staging corpus: 2,996 real HTTP checks passed, including all 187 tracked public assets; HTTP/MCP: 15 passed; browser: 59 passed; isolated PostgreSQL: 7 passed. The nested-tab regressions and six new navigation/search regressions failed before their fixes and pass afterward.
  • Local lint, all 26 workspace type checks, all 61 repository audits, and the docs workspace test passed. The full local run passed 634 script tests and 19 workspace tasks. The latest app run passed 38,713 tests with eight skipped, the same two previously isolated executor timeouts, and four worker startup errors. A focused one-worker rerun of those four files passed all 33 tests. The full root gate remains unsuccessful because of the two executor failures. The desktop suite passed after temporarily providing matching cached Node headers. No executor or desktop source was changed.
  • Verification, reports and limitations, architecture, and machine interfaces.
  • Live paid embeddings and production index publication were not run. Workflow node text is server rendered; the shared canvas completes measurement and painting during hydration.

Deployment

The requested move to https://sim.ai/docs requires coordinated AWS routing, a path-aware Vercel build and an old-host redirect. The cutover plan records the URL, asset, search, MCP and SEO requirements. No live domains, infrastructure or deployment settings were changed.

Screenshots

Preserved sidebar position
Nested section navigation
Introduction with the wider article and aligned outline
API reference

Updated dark reading theme

Rounded expanded screenshot

Rollback

Revert the docs replacement and follow-up commits, including dependency and workflow changes. No database migration or product-data rollback is required. This PR remains a draft.

@vercel

vercel Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Oct 30, 2026 3:39am UTC

Request Review

@emir-karabeg emir-karabeg changed the title feat(docs): rebuild documentation with the Paper design system feat(docs): rebuild documentation with the shared Sim design system Oct 30, 2026

This branch was successfully deployed

1 active deployment
Preview — 74b58e8f Deployed Oct 30, 2026 by vercel[bot]
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