docs(docs-next): port home, getting started, architecture (phase 2)#113
Merged
pratyush618 merged 3 commits intomasterfrom May 2, 2026
Merged
docs(docs-next): port home, getting started, architecture (phase 2)#113pratyush618 merged 3 commits intomasterfrom
pratyush618 merged 3 commits intomasterfrom
Conversation
Real content ported from the Zensical site for the docs landing, concepts, installation, and quickstart pages. Material admonitions and tabbed code blocks rewritten as Fumadocs Callout / Tabs / Card components.
Eight architecture pages ported from the Zensical site (overview, job-lifecycle, worker-pool, scheduler, storage, resources, failure-model, serialization). Mermaid diagrams use the new <Mermaid> component; admonitions become Fumadocs Callouts.
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
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.
Phase 2 of the docs migration: port the highest-traffic content from the Zensical site into the new Fumadocs site at
docs-next/. Zensical site atdocs/is untouched and still ships unchanged; this PR only fills in stubs indocs-next/content/docs/.What's ported (12 pages)
Home (1)
docs/index.md→docs-next/content/docs/index.mdx— short intro paragraph adapted from the Zensical landing, plus the existing 4-card hubGetting Started (3)
docs/getting-started/index.md→docs-next/content/docs/getting-started/concepts.mdx(renamed from "Overview" to "Concepts" per the new IA, with a brief mental-model section added)docs/getting-started/installation.md→docs-next/content/docs/getting-started/installation.mdx— Material!!! noteadmonitions rewritten as Fumadocs<Callout type="info">; bumped Python requirement note to 3.10+ and__version__to 0.12.0docs/getting-started/quickstart.md→docs-next/content/docs/getting-started/quickstart.mdx— Material=== "Tab Name"blocks rewritten as Fumadocs<Tabs>/<Tab>Architecture (8)
mermaidfences to<Mermaid chart={...} />(see infrastructure section below)meta.jsonordering set to: overview → job-lifecycle → worker-pool → scheduler → storage → resources → failure-model → serializationInfrastructure changes
<Mermaid>component — Fumadocs ships callout/card/tabs but not Mermaid, so PR adds a small client component (docs-next/src/components/mermaid.tsx, ~40 lines) that lazy-importsmermaid, picks the dark/default theme fromnext-themes, and renders the SVG viadangerouslySetInnerHTML. Registered globally indocs-next/src/components/mdx.tsxso MDX pages can use<Mermaid chart="..." />without per-file imports.Direct deps added —
mermaidandnext-themes(the latter was a transitive dep, now direct because the new component imports it).Conversion rules applied
# Title(h1)title:+description:!!! note "X"/!!! warning<Callout title="X" type="info">/<Callout type="warn"><div class="grid cards" markdown><Cards>/<Card>=== "Tab"<Tabs items={[...]}>/<Tab value="...">```mermaidfence<Mermaid chart={...} />[:octicons-arrow-right-24: Text](path)[Text →](/docs/path):material-icon:{ .lg .middle }(other-page.md)(/docs/section/other-page)Test plan
pnpm types:check— clean (✓ Types generated successfully)pnpm lint— exit 0 (2 warnings on Fumadocs scaffold's!importantCSS, intentional)pnpm build— 75 static pages generated (was 66 before this PR), no warnings, no errorsout/llms.txtandout/llms-full.txtregenerated with new contentpnpm --dir docs-next dev, click through all 12 ported pages, verify Mermaid diagrams render in both light and dark mode, verify Tabs and Callouts render correctlyBuild Docs (Next)job stays greenCommits
feat(docs-next): add mermaid component— adds<Mermaid>(registered globally), pulls inmermaid+next-themesdirect depsdocs(docs-next): port home + getting started— 4 MDX filesdocs(docs-next): port architecture section— 8 MDX files + meta.json orderingWhat's NOT in here (next phases)
<APIMethod>component (phase 3)