Skip to content

chore(content): add a v2 beta banner linking to the v1 docs - #1940

Merged
dinwwwh merged 1 commit into
middleapi:mainfrom
dinwwwh:claude/orpc-v2-beta-banner-9efa89
Aug 24, 2026
Merged

chore(content): add a v2 beta banner linking to the v1 docs#1940
dinwwwh merged 1 commit into
middleapi:mainfrom
dinwwwh:claude/orpc-v2-beta-banner-9efa89

Conversation

@dinwwwh

@dinwwwh dinwwwh commented Aug 24, 2026

Copy link
Copy Markdown
Member

Every docs page now opens with a bar saying the reader is on the v2 docs and that v2 is still in beta, with a link across to v1.orpc.dev. Readers who arrive from a search result no longer have to work out which major version they landed on, and v1 users have a visible way back.

The bar is closable, and the choice is remembered per visitor.

Notes

Uses Blume's built-in banner, so the bar covers docs pages, the landing page, and the blog: the custom pages already pass config.banner through to PageLayout. The close button works with this site's forked header, which carries the dismiss handler and re-measures the mobile drawer offset afterwards.

Dismissal is keyed on the message text, so editing the copy later re-shows the bar to everyone who closed it. Add an id if that ever becomes unwanted.

Testing

Config validated through Blume's own schema loader, which normalizes the banner as expected. eslint and tsc -p apps/content report nothing on the changed file. The docs site was not built or served.

Readers landing anywhere in the docs now see that these are the v2 docs and that v2 is still in beta, with a way over to v1.orpc.dev.
@pkg-pr-new

pkg-pr-new Bot commented Aug 24, 2026

Copy link
Copy Markdown
More templates

@orpc/ai-sdk

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

@orpc/arktype

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

@orpc/bun

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

@orpc/client

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

@orpc/cloudflare

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

@orpc/contract

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

@orpc/experimental-effect

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

@orpc/evlog

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

@orpc/hibernation

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

@orpc/json-schema

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

@orpc/experimental-msw

npm i https://pkg.pr.new/@orpc/experimental-msw@1940

@orpc/nest

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

@orpc/next

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

@orpc/node

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

@orpc/openapi

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

@orpc/opentelemetry

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

@orpc/pinia-colada

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

@orpc/pino

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

@orpc/publisher

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

@orpc/ratelimit

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

@orpc/server

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

@orpc/shared

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

@orpc/swr

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

@orpc/tanstack-query

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

@orpc/trpc

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

@orpc/valibot

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

@orpc/zod

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

commit: 0291f6f

@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 — single commit adding a site-wide dismissible banner to apps/content/blume.config.ts (content + link to https://v1.orpc.dev + dismissible: true), rendering on docs, landing, and blog pages.

I verified the config mechanically rather than trusting it on sight:

  • The object form matches Blume's BannerConfig type in dist/types/core/config-input.d.ts (content, dismissible, link.{href,text}, optional id), so the schema loader accepts it.
  • The external link survives withBase()/prefixBase() untouched (only root-relative routes get the base prefix; the site base is /).
  • Dismissal works with this site's forked components/blume/Header.astro, which already carries the data-blume-banner-dismiss handler and re-measures the mobile drawer offset, and the data-banner-key Blume stamps on the bar.
  • Dismissal is keyed on banner.id ?? banner.content (content, since no id is set) — the PR body documents this and the id escape hatch if copy edits should not re-show the bar.
  • v1.orpc.dev resolves and is live.

This touches no code or tests; it adds user-visible chrome to the live docs site, which is exactly the stated intent.

Pullfrog  | View workflow run | Using DeepSeek Flash (free via Pullfrog for OSS) | 𝕏

@codecov

codecov Bot commented Aug 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@codspeed-hq

codspeed-hq Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Merging this PR will not alter performance

✅ 30 untouched benchmarks


Comparing dinwwwh:claude/orpc-v2-beta-banner-9efa89 (0291f6f) with main (e81bf30)

Open in CodSpeed

@dinwwwh
dinwwwh merged commit 2f2bf60 into middleapi:main Aug 24, 2026
10 checks passed
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