Skip to content

docs: add v3 deprecation audit#2246

Draft
benpsnyder wants to merge 4 commits intoanalogjs:alphafrom
benpsnyder:chore/2215-deprecation-audit
Draft

docs: add v3 deprecation audit#2246
benpsnyder wants to merge 4 commits intoanalogjs:alphafrom
benpsnyder:chore/2215-deprecation-audit

Conversation

@benpsnyder
Copy link
Copy Markdown
Contributor

@benpsnyder benpsnyder commented Apr 5, 2026

Exists as a draft to work on a docs page ahead of v3 release regarding deprecations, etc.
Per direction from maintainer, will not do any deprecation implementation until finalized.

Reference:

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 5, 2026

Deploy Preview for analog-blog ready!

Name Link
🔨 Latest commit 454e546
🔍 Latest deploy log https://app.netlify.com/projects/analog-blog/deploys/69d29ccf683a0700087d738a
😎 Deploy Preview https://deploy-preview-2246--analog-blog.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 5, 2026

Deploy Preview for analog-app ready!

Name Link
🔨 Latest commit 454e546
🔍 Latest deploy log https://app.netlify.com/projects/analog-app/deploys/69d29ccf9ebbc40008a6a657
😎 Deploy Preview https://deploy-preview-2246--analog-app.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions Bot added scope:docs Documentation changes scope:platform Changes in @analogjs/platform scope:router Changes in @analogjs/router scope:vite-plugin-nitro Changes in @analogjs/vite-plugin-nitro labels Apr 5, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 5, 2026

This PR touches multiple package scopes: platform, router, vite-plugin-nitro.

Please confirm the changes are closely related. Squash merge is highly preferred. If you recommend a non-squash merge, add a brief note explaining why the commit boundaries matter and why this PR should bypass focused changes per package.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 5, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6fa7ba5b-4be6-4632-9e6f-e5a4a389dbb3

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

The PR introduces a comprehensive deprecation audit for Analog v3 prerelease, adding a new deprecation guide that documents deprecated APIs (defineRouteMeta, useAPIMiddleware, and tRPC client aliases) with upgrade paths and a removal timeline. Documentation updates are added to the updating guide and migration guide, and JSDoc annotations are updated in the platform and vite-plugin packages to mark useAPIMiddleware as deprecated with guidance text. No runtime logic, export signatures, or control flow are modified.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed Title follows Conventional Commit style with 'docs:' scope prefix and clearly summarizes the main change: adding a v3 deprecation audit.
Linked Issues check ✅ Passed Changes fully satisfy issue #2215 requirements: comprehensive deprecation audit documented with a matrix, removal plan defined, and deprecated source annotations tightened across packages.
Out of Scope Changes check ✅ Passed All changes are directly scoped to the linked issue: documentation additions for the deprecation audit, JSDoc updates marking APIs as deprecated, and example updates guiding toward preferred patterns.
Description check ✅ Passed The PR description clearly relates to the changeset, explaining that it adds documentation for a v3 deprecation audit and is intentionally draft-stage without implementation changes.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@benpsnyder benpsnyder marked this pull request as draft April 5, 2026 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

scope:docs Documentation changes scope:platform Changes in @analogjs/platform scope:router Changes in @analogjs/router scope:vite-plugin-nitro Changes in @analogjs/vite-plugin-nitro

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant