From f84cf8fbbc75b8f12bacbde9456601133283e05b Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 23 Oct 2026 06:37:03 +0000 Subject: [PATCH] docs: say the docs cover the v2 beta and where v1 lives npm's `latest` tag still points at v1, so a plain install silently gives readers and agents the wrong major version. State it where they install: - Getting Started explains why every command uses `@beta`, what a plain install gets, and links the v1 docs and the migration guide (which also gives the migration guide its first in-body link). - The migration guide says v2 is published under the `beta` tag. - The docs MCP server sends the same version hint to connecting agents as its `instructions`, which Blume also uses as its ai-catalog entry. Co-Authored-By: Claude Opus 5.5 (1M context) Claude-Session: https://claude.ai/code/session_017NNWP7iMJaiwLC5YGPh77L --- apps/content/blume.config.ts | 4 ++++ apps/content/docs/getting-started.mdx | 2 ++ apps/content/docs/migrations/from-v1.mdx | 2 +- 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/apps/content/blume.config.ts b/apps/content/blume.config.ts index 24326710d1..1499184b9a 100644 --- a/apps/content/blume.config.ts +++ b/apps/content/blume.config.ts @@ -257,6 +257,10 @@ export default defineConfig({ }, mcp: { enabled: true, + // Sent to every connecting agent and reused as the server's ai-catalog + // description. Pretrained oRPC knowledge is mostly v1, so name the + // version and how to install it; update once v2 leaves beta. + instructions: 'Search and read the oRPC v2 documentation as Markdown. v2 is in beta and installs with the `@beta` tag (`npm install @orpc/server@beta @orpc/client@beta`); a plain install gets v1, whose APIs differ. If a project has `@orpc/*` 1.x installed, use the v1 docs at https://v1.orpc.dev, or https://orpc.dev/docs/migrations/from-v1 to upgrade.', }, skills: '../../skills', }, diff --git a/apps/content/docs/getting-started.mdx b/apps/content/docs/getting-started.mdx index fdcd3c0d46..1c8423fc74 100644 --- a/apps/content/docs/getting-started.mdx +++ b/apps/content/docs/getting-started.mdx @@ -25,6 +25,8 @@ Install the server and client packages, plus a schema library for validating inp npm install @orpc/server@beta @orpc/client@beta zod ``` +These docs cover oRPC v2, currently in beta, so every install command in them uses the `@beta` tag. A plain `npm install @orpc/server` still installs v1, the current stable release, whose APIs differ from what these docs show. If your project is on v1, read the [v1 docs](https://v1.orpc.dev), or upgrade with [Migrating from oRPC v1](/docs/migrations/from-v1). + ## Define a Router A procedure is a function that clients can call remotely. Build one with the `os` builder (short for oRPC server): optionally describe the input it accepts with a schema, then implement it with `.handler`. A router is a plain object that groups procedures and gives each one its calling path, like `planet.list`. diff --git a/apps/content/docs/migrations/from-v1.mdx b/apps/content/docs/migrations/from-v1.mdx index 0fcd776142..a1575d2ea0 100644 --- a/apps/content/docs/migrations/from-v1.mdx +++ b/apps/content/docs/migrations/from-v1.mdx @@ -18,7 +18,7 @@ Most of your code keeps working: many v1 names still compile through deprecated ## Update Packages -Install the v2 versions of the packages you use: +Install the v2 versions of the packages you use. Until v2 is stable, it is published under the `beta` npm tag, so installing without `@beta` gives you v1: ```sh v2 npm install @orpc/server@beta @orpc/client@beta