Skip to content

feat: add official Farm.js docs adapter - #364

Draft
Kinfe123 wants to merge 4 commits into
mainfrom
feat/farmjs-adapter
Draft

feat: add official Farm.js docs adapter#364
Kinfe123 wants to merge 4 commits into
mainfrom
feat/farmjs-adapter

Conversation

@Kinfe123

@Kinfe123 Kinfe123 commented Jul 21, 2026

Copy link
Copy Markdown
Member

Summary

  • add the publishable @farming-labs/farmjs package with config, React, MDX/Vite, content, server, MCP, agent, and API-reference entrypoints
  • add a Farm-native withDocs() contract plus createDocsServer().handle(request) for custom request pipelines and non-docs fallthrough
  • register Farm.js in shared agent telemetry, adapter conformance, and app/api/**/route.ts API discovery
  • add CLI detection, existing-project init, config wrapping, upgrade/downgrade package selection, docs, and focused tests

Validation

  • pnpm --filter @farming-labs/docs test (52 files, 836 tests)
  • pnpm --filter @farming-labs/farmjs test (2 files, 7 tests)
  • pnpm typecheck
  • pnpm format:check
  • pnpm lint (0 errors; existing repository warnings only)
  • pnpm pack for @farming-labs/farmjs and verified all declared entrypoints

Rollout note

@farmjs/core is not currently published on npm, so this draft intentionally does not add it as a peer dependency or expose a fresh --template farmjs bootstrap that could not install successfully. Existing-project detection and scaffolding are included. A coordinated Farm core release can consume the structural docs config contract, then add the peer dependency and fresh template in a follow-up.


Summary by cubic

Adds official Farm.js support to @farming-labs/docs via the new @farming-labs/farmjs adapter, with config, server, React, Vite, and API reference integration. Also updates CLI, API discovery, and telemetry to detect and work with Farm.js.

  • New Features

    • New @farming-labs/farmjs package: withDocs() config wrapper, createDocsServer() with .handle()/.load(), FarmDocsPage renderer, docsMdx Vite plugin, and Farm API reference builder.
    • CLI: auto-detects Farm.js, adds Farm init templates/scaffolding, and includes farmjs in upgrade/downgrade presets.
    • API discovery: finds Farm routes at src/app/api/**/route.ts for API reference.
    • Agents/telemetry: adds Farm to adapter conformance, usefulness patterns, and shared telemetry surfaces.
  • Migration

    • Enable docs by wrapping farm.config.ts with withDocs(defineConfig(...)) from @farming-labs/farmjs/config.
    • For custom pipelines, call createDocsServer().handle(request) and fall through non-docs routes.
    • Note: No @farmjs/core peer dependency yet; a coordinated core release will follow.

Written for commit fe6486a. Summary will update on new commits.

Review in cubic

@vercel

vercel Bot commented Jul 21, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
docs-website Ready Ready Preview, Comment Jul 21, 2026 1:24pm
farming-labs-docs-docs-cloud Building Building Preview, Comment Jul 21, 2026 1:24pm

Request Review

@pkg-pr-new

pkg-pr-new Bot commented Jul 21, 2026

Copy link
Copy Markdown

Open in StackBlitz

@farming-labs/astro

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/astro@364

@farming-labs/astro-theme

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/astro-theme@364

@farming-labs/docs

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/docs@364

@farming-labs/farmjs

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/farmjs@364

@farming-labs/theme

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/theme@364

@farming-labs/next

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/next@364

@farming-labs/nuxt

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/nuxt@364

@farming-labs/nuxt-theme

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/nuxt-theme@364

@farming-labs/svelte

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/svelte@364

@farming-labs/svelte-theme

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/svelte-theme@364

@farming-labs/tanstack-start

pnpm add https://pkg.pr.new/farming-labs/docs/@farming-labs/tanstack-start@364

commit: fe6486a

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