feat: add official Farm.js docs adapter - #364
Draft
Kinfe123 wants to merge 4 commits into
Draft
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
@farming-labs/astro
@farming-labs/astro-theme
@farming-labs/docs
@farming-labs/farmjs
@farming-labs/theme
@farming-labs/next
@farming-labs/nuxt
@farming-labs/nuxt-theme
@farming-labs/svelte
@farming-labs/svelte-theme
@farming-labs/tanstack-start
commit: |
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.
Summary
@farming-labs/farmjspackage with config, React, MDX/Vite, content, server, MCP, agent, and API-reference entrypointswithDocs()contract pluscreateDocsServer().handle(request)for custom request pipelines and non-docs fallthroughapp/api/**/route.tsAPI discoveryValidation
pnpm --filter @farming-labs/docs test(52 files, 836 tests)pnpm --filter @farming-labs/farmjs test(2 files, 7 tests)pnpm typecheckpnpm format:checkpnpm lint(0 errors; existing repository warnings only)pnpm packfor@farming-labs/farmjsand verified all declared entrypointsRollout note
@farmjs/coreis not currently published on npm, so this draft intentionally does not add it as a peer dependency or expose a fresh--template farmjsbootstrap that could not install successfully. Existing-project detection and scaffolding are included. A coordinated Farm core release can consume the structuraldocsconfig contract, then add the peer dependency and fresh template in a follow-up.Summary by cubic
Adds official Farm.js support to
@farming-labs/docsvia the new@farming-labs/farmjsadapter, 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
@farming-labs/farmjspackage:withDocs()config wrapper,createDocsServer()with.handle()/.load(),FarmDocsPagerenderer,docsMdxVite plugin, and Farm API reference builder.farmjsin upgrade/downgrade presets.src/app/api/**/route.tsfor API reference.Migration
farm.config.tswithwithDocs(defineConfig(...))from@farming-labs/farmjs/config.createDocsServer().handle(request)and fall through non-docs routes.@farmjs/corepeer dependency yet; a coordinated core release will follow.Written for commit fe6486a. Summary will update on new commits.