Sourced*

Agent playbooks

Agent playbook: migrate Fern docs and SDKs to Sourced

· 2 min read · Sourced

  • agents
  • fern
  • migration
  • sdks
  • docs

Fern already combines docs and SDKs, so a migration agent must be stricter. The goal is not simply to regenerate output. The goal is to preserve customer-facing SDK and docs behavior while moving release control into Sourced.

Inventory

Find:

  • fern.config.json, generators.yml, and OpenAPI source.
  • Generated SDK package names, import paths, and auth environment variables.
  • Docs URLs, versions, product switchers, and custom domain.
  • MDX or custom React components.
  • CI workflows that publish packages or docs.
  • Any generated MCP or agent instructions.

What to compare

Compare old Fern output to Sourced preview output:

  • TypeScript and Python method names.
  • Constructor shape and auth setup.
  • Pagination helpers.
  • Error classes.
  • README examples.
  • Package metadata.
  • Docs route structure.
  • llms.txt quality.
  • MCP tool names and input schemas.
  • Skill-file safety instructions.

Prerequisites

Before using Sourced, confirm there is a signed-in Sourced workspace approved by the owner, canonical OpenAPI access, Fern docs and SDK package source access, package names, import paths, auth environment variables, redirect map, DNS owner approval for any later cutover, and local Node 20+, pnpm 10+, and Python 3.10+ for proof checks. The upload path is /dashboard/projects for normal OpenAPI previews after approval.

Manual path

Use Fern's config and generator output as the old contract. Generate new SDKs with your chosen tool, then diff method surfaces and docs routes manually. This requires careful package smoke testing before npm or PyPI publish.

Sourced path

After approval, upload OpenAPI to Sourced and use the preview artifacts:

  • Client packages for TypeScript and Python.
  • Docs preview and WYSIWYG guide surface.
  • Standalone skill-file generator and MCP server generator when agent artifacts are needed.
  • Release readiness for GitHub, npm, PyPI, private noindex docs URLs, DNS readiness, and explicitly approved production custom-domain cutover.

Do not turn on real publishing until a human accepts the compatibility report and approves the exact repo, branch, package, version, docs domain, DNS record, and indexability change.

Agent prompt

Migrate our Fern API docs and SDK workflow to Sourced.
Inventory fern.config.json, generators.yml, OpenAPI, package names, docs routes, CI, and custom domain.
Confirm Sourced workspace access, old SDK package/repo access, package names/import paths/auth env vars, redirect map, DNS owner approval, and local Node/pnpm/Python proof tools.
Compare old and new SDK public surfaces and docs routes.
Use Sourced previews after approval for client packages and docs; use separate Sourced skill-file and MCP tools if needed.
Do not publish packages, change DNS, or upload private API material until the owner approves that exact action. Produce an approval checklist.

Fit check

If the team needs many SDK languages immediately, Fern may remain the better generator. If the team wants TypeScript and Python packages, docs previews, standalone skill/MCP tools, and approval-gated release checks around one OpenAPI workflow, Sourced is a fit.