Skip to content

docs: say the docs cover the v2 beta and where v1 lives - #2315

Closed
dinwwwh wants to merge 1 commit into
mainfrom
claude/project-thread-d7km27
Closed

dinwwwh wants to merge 1 commit into
mainfrom
claude/project-thread-d7km27

Conversation

@dinwwwh

@dinwwwh dinwwwh commented Oct 23, 2026

Copy link
Copy Markdown
Member

Requested by dinwwwh · project thread

Why

npm's latest tag for @orpc/server and @orpc/client is still 1.16.1 (v2 is 2.0.0-beta.45 under beta), so a plain npm install gives v1 while orpc.dev documents v2. Every install command on the site already uses @beta, and the header banner says "v2 beta", but the banner is not in the page Markdown, llms-full.txt, or MCP output, and nothing in the page body says why @beta is there. Readers and AI assistants can end up mixing v1 and v2 APIs.

Changes

  • Getting Started: one paragraph after the install command. It says the docs cover the v2 beta (so every command uses @beta), that a plain install gets v1, and links the v1 docs and the migration guide. It is plain prose rather than a callout, so it also gives /docs/migrations/from-v1 its first in-body link (Blume's orphan check skips callouts; orphan pages go from 27 to 26).
  • Migrating from v1: the "Update Packages" step says v2 is published under the beta tag, so installing without @beta gives you v1.
  • Docs MCP server: sets agents.mcp.instructions with the same version hint. Blume sends it to connecting agents on initialize and also uses it as the MCP entry's description in /.well-known/ai-catalog.json.

llms.txt already carries this note through agents.llmsTxt.details (#2313), so it is not repeated there. The Getting Started paragraph, the migration guide sentence and the MCP instructions need updating when v2 leaves beta.

Verification

  • pnpm build in apps/content (OG images off locally, since the sandbox can't fetch fonts): the new text shows up in docs/getting-started.md, llms-full.txt, ai-catalog.json, and the MCP data chunk.
  • blume audit: /docs/migrations/from-v1 is no longer listed as an orphan.
  • pnpm docs:validate passes (0 backlink errors, no broken links), and eslint is clean on blume.config.ts.

Generated by Claude Code

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) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017NNWP7iMJaiwLC5YGPh77L
@dinwwwh dinwwwh self-assigned this Oct 23, 2026
@macroscopeapp

macroscopeapp Bot commented Oct 23, 2026

Copy link
Copy Markdown

Approvability

Verdict: Approved at f84cf8f

Macroscope's review found this PR approvable — This PR makes a focused documentation update clarifying the v2 beta install tag and directing v1 users to the correct docs. It also updates existing MCP agent guidance and catalog text, without changing application request behavior, APIs, schemas, or infrastructure.

You can add or adjust custom eligibility rules. Learn more.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
orpc f84cf8f Commit Preview URL

Branch Preview URL
Oct 23 2026, 06:39 AM

dinwwwh commented Oct 23, 2026

Copy link
Copy Markdown
Member Author

All four test_matrix jobs (Node 20, 22, 24, 26) fail for a reason outside this PR: the Upstash Redis database CI uses has hit its request quota (ERR max requests limit exceeded. Limit: 500000, Usage: 500000). The only failing tests are the Upstash-backed ones in packages/publisher/tests/redis-adapters-compatibility.test.ts and packages/ratelimit/src/adapters/upstash.test.ts. The other 4064 tests pass, and lint_and_typecheck and the Workers build are green.

This PR only touches docs content and blume.config.ts, and main passed CI at 3ff2342 about 15 minutes before this run. A code change can't fix this. The quota has to reset, or the plan or database behind the CI secret has to change. I'm re-running the failed jobs once.


Generated by Claude Code

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ No new issues found.

Reviewed changes

Docs-only PR adding a v2-beta version hint in three places so readers and AI agents don't mix v1 and v2 APIs.

  • blume.config.ts MCP instructions — new agents.mcp.instructions string naming the v2 beta, the @beta install, and where v1 lives. Valid McpConfig field, used both as the connecting-agent hint and the ai-catalog MCP description.
  • Getting Started paragraph — states the docs cover v2 beta, that every install command uses @beta, that a plain install is v1, and links the v1 docs plus the migration guide.
  • Migrating from v1 — the "Update Packages" step now says v2 ships under the beta tag.

I verified the load-bearing claims: npm latest for @orpc/server and @orpc/client is 1.16.1 while beta is 2.0.0-beta.45, https://v1.orpc.dev resolves and is already referenced by the banner/footer/skills, agents.mcp.instructions is a real Blume 2.2.3 option (consumed at ai-catalog.ts:141), and no install command in the docs omits @beta.

Pullfrog  | View workflow run | Using deepseek-v4.1-flash (free via Pullfrog for OSS) | 𝕏

@pkg-pr-new

pkg-pr-new Bot commented Oct 23, 2026

Copy link
Copy Markdown
More templates

@orpc/ai-sdk

npm i https://pkg.pr.new/@orpc/ai-sdk@2315

@orpc/arktype

npm i https://pkg.pr.new/@orpc/arktype@2315

@orpc/bun

npm i https://pkg.pr.new/@orpc/bun@2315

@orpc/client

npm i https://pkg.pr.new/@orpc/client@2315

@orpc/cloudflare

npm i https://pkg.pr.new/@orpc/cloudflare@2315

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@2315

@orpc/experimental-effect

npm i https://pkg.pr.new/@orpc/experimental-effect@2315

@orpc/evlog

npm i https://pkg.pr.new/@orpc/evlog@2315

@orpc/hibernation

npm i https://pkg.pr.new/@orpc/hibernation@2315

@orpc/json-schema

npm i https://pkg.pr.new/@orpc/json-schema@2315

@orpc/experimental-lock

npm i https://pkg.pr.new/@orpc/experimental-lock@2315

@orpc/mcp

npm i https://pkg.pr.new/@orpc/mcp@2315

@orpc/msw

npm i https://pkg.pr.new/@orpc/msw@2315

@orpc/nest

npm i https://pkg.pr.new/@orpc/nest@2315

@orpc/next

npm i https://pkg.pr.new/@orpc/next@2315

@orpc/node

npm i https://pkg.pr.new/@orpc/node@2315

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@2315

@orpc/opentelemetry

npm i https://pkg.pr.new/@orpc/opentelemetry@2315

@orpc/pinia-colada

npm i https://pkg.pr.new/@orpc/pinia-colada@2315

@orpc/pino

npm i https://pkg.pr.new/@orpc/pino@2315

@orpc/publisher

npm i https://pkg.pr.new/@orpc/publisher@2315

@orpc/ratelimit

npm i https://pkg.pr.new/@orpc/ratelimit@2315

@orpc/server

npm i https://pkg.pr.new/@orpc/server@2315

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@2315

@orpc/swr

npm i https://pkg.pr.new/@orpc/swr@2315

@orpc/tanstack-query

npm i https://pkg.pr.new/@orpc/tanstack-query@2315

@orpc/trpc

npm i https://pkg.pr.new/@orpc/trpc@2315

@orpc/valibot

npm i https://pkg.pr.new/@orpc/valibot@2315

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@2315

commit: f84cf8f

@codspeed

codspeed Bot commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

Merging this PR will not alter performance

1 warning

⚠️ 6 benchmarks are dominated by system calls

System calls cannot be simulated consistently and are left out of the measure. The reported value understates the real cost. Switch to the Walltime instrument to measure them.

Learn more about system calls

See affected benchmarks

✅ 28 untouched benchmarks
⏩ 2 skipped benchmarks1


Comparing claude/project-thread-d7km27 (f84cf8f) with main (3ff2342)

Open in CodSpeed

Footnotes

  1. 2 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

@dinwwwh dinwwwh closed this Oct 23, 2026
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.

2 participants