Home /

docs

Migrate to Farming Labs Docs

Move an existing documentation site without treating the migration as a rewrite. Start with the guide for your current platform, preserve the source URLs where possible, and validate the new site before changing production traffic.

Share one Markdown entry point

Send /docs/migrations.md to an agent. It contains this migration map and direct links to every source-specific .md guide, so the agent can fetch only the framework it needs.

Choose your current platform

Choose the target runtime

The migration guide explains the source format. The Farming Labs initializer determines the target file layout:

Target runtimeContent locationConfiguration
Next.jsapp/docs/**/page.mdx or src/app/docs/**/page.mdxdocs.config.ts at the project root
TanStack Startdocs/**/*.mdxdocs.config.ts at the project root
SvelteKitdocs/**/*.md or docs/**/*.mdxsrc/lib/docs.config.ts
Astrodocs/**/*.md or docs/**/*.mdxsrc/lib/docs.config.ts
Nuxtdocs/**/*.md or docs/**/*.mdxdocs.config.ts at the project root

Run the initializer from the target application root:

terminal
npx @farming-labs/docs init

The migration sequence

  1. Freeze a source snapshot. Record the published URL, active version, locale, and build command.
  2. Initialize the target separately. Use a migration branch or a new directory so rollback stays simple.
  3. Move plain content first. Copy Markdown, images, and downloadable files before translating components.
  4. Rebuild navigation. Preserve page order, nesting, labels, hidden pages, and external links.
  5. Translate source components. Prefer built-in Callout, Tabs, Cards, and standard Markdown.
  6. Recreate integrations intentionally. Search, analytics, authentication, OpenAPI, redirects, and custom scripts are configuration work—not content.
  7. Validate before cutover. Build the site, compare important routes, inspect mobile navigation, and test .md delivery.

Definition of done

  • Every published source page is migrated, redirected, or intentionally retired.
  • The target production build succeeds without placeholder imports.
  • Sidebar order and nesting match the approved information architecture.
  • Internal links, headings, images, downloads, and code blocks work.
  • Search and API reference behavior are verified separately.
  • /docs/migrations.md-style Markdown delivery works for migrated pages.
  • Custom components and hosted integrations have an owner and a documented decision.
  • The source deployment remains available until the target site passes the final route comparison.

Markdown guide index

Give an agent the smallest guide that matches the source:

Customize
Live preview on these docs
Reset
Customize
Export Code
Preset
Explore more themes
Primary Color
Primary
Colors
Background
Foreground
Muted Text
Border
Card
Muted BG
Ring
Layout
SidebarBordered
TOC StyleDirectional (tree)
TOC DepthH2 + H3
Ask AI
ModeFloating
Floating StyleFull Modal
PositionBottom Right
Features