chore(backend,react,shared,vue): Update docs links#8047
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🦋 Changeset detectedLatest commit: 4b2eae7 The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
alexisintech
changed the title
@clerk/agent-toolkit
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/dev-cli
@clerk/expo
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/hono
@clerk/localizations
@clerk/nextjs
@clerk/nuxt
@clerk/react
@clerk/react-router
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/ui
@clerk/upgrade
@clerk/vue
commit: |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThis pull request updates documentation link targets across the repository from JavaScript-specific reference paths to object- and type-based reference paths. Changes include edits to the typedoc custom plugin mappings and numerous JSDoc comments in backend, shared, React, and Vue packages. Only string literals and documentation links were modified; there are no runtime, type-signature, or public API changes. Possibly related PRs
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/backend/src/api/resources/CommercePlan.ts`:
- Line 7: The changes replace working doc links with new routes that aren't live
yet; stop this merge and either revert the updated links back to the current
working routes (e.g., the javascript/types and objects paths) or hold the PR
until clerk/clerk-docs#3185 is deployed with redirects; specifically, in the
CommercePlan.ts description referencing the `BillingPlan` object (and any other
files that now point to `/docs/reference/types/*` or
`/docs/reference/objects/*`), restore the original
`/docs/reference/javascript/types/*` and `/docs/reference/objects/*` links or
wait to update all links in one coordinated change once the docs PR is live.
In `@packages/vue/src/composables/useSignUp.ts`:
- Line 12: The docs link in the JSDoc for useSignUp.ts currently points to the
new /docs/reference/objects/sign-up which 404s; revert or gate that change by
updating the link text in the comment that starts with "Returns the current
[`SignUp`](" to use the existing published URL
/docs/reference/javascript/sign-up (or wrap the new URL behind a runtime/feature
flag if you prefer gating), so the comment references the live SignUp docs until
the new route is published.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: 4b2543df-9d3a-4e71-aff5-b0a22f6951a2
📒 Files selected for processing (31)
.typedoc/custom-plugin.mjspackages/backend/src/api/resources/APIKey.tspackages/backend/src/api/resources/Client.tspackages/backend/src/api/resources/CommercePlan.tspackages/backend/src/api/resources/CommerceSubscription.tspackages/backend/src/api/resources/CommerceSubscriptionItem.tspackages/backend/src/api/resources/Invitation.tspackages/backend/src/api/resources/Organization.tspackages/backend/src/api/resources/OrganizationInvitation.tspackages/backend/src/api/resources/OrganizationMembership.tspackages/backend/src/api/resources/SamlConnection.tspackages/backend/src/api/resources/Session.tspackages/react/src/components/controlComponents.tsxpackages/react/src/hooks/legacy/useSignIn.tspackages/react/src/hooks/legacy/useSignUp.tspackages/shared/src/react/hooks/useClerk.tspackages/shared/src/react/hooks/useOrganization.tsxpackages/shared/src/react/hooks/useSession.tspackages/shared/src/react/hooks/useSessionList.tspackages/shared/src/react/hooks/useUser.tspackages/shared/src/react/types.tspackages/shared/src/types/hooks.tspackages/shared/src/types/session.tspackages/vue/src/components/controlComponents.tspackages/vue/src/composables/useClerk.tspackages/vue/src/composables/useOrganization.tspackages/vue/src/composables/useSession.tspackages/vue/src/composables/useSessionList.tspackages/vue/src/composables/useSignIn.tspackages/vue/src/composables/useSignUp.tspackages/vue/src/composables/useUser.ts
|
|
||
| /** | ||
| * The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/reference/javascript/types/billing-plan-resource) object as it holds information about a Plan, as well as methods for managing it. However, the `BillingPlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API. | ||
| * The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/reference/types/billing-plan-resource) object as it holds information about a Plan, as well as methods for managing it. However, the `BillingPlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, let's look at the CommercePlan.ts file to see the actual documentation links
cat -n packages/backend/src/api/resources/CommercePlan.ts | head -20Repository: clerk/javascript
Length of output: 1261
🏁 Script executed:
# Check for similar documentation route changes in the PR
git diff HEAD~1 -- '**/*.ts' '**/*.tsx' | grep -A 3 -B 3 'docs/reference' | head -50Repository: clerk/javascript
Length of output: 88
🏁 Script executed:
# Search for documentation link patterns in the codebase to understand the scope
rg 'docs/reference/(types|objects)' --type ts --type tsx -cRepository: clerk/javascript
Length of output: 87
🏁 Script executed:
# Search for documentation links in TypeScript files
rg 'docs/reference' --type ts -c 2>/dev/null || rg 'docs/reference' -t ts -c 2>/dev/null || rg 'docs/reference' | grep -E '\.(ts|tsx):' | head -30Repository: clerk/javascript
Length of output: 3294
🏁 Script executed:
# Look for any recent commits or changes that might indicate the PR scope
git log --oneline -10 2>/dev/null || echo "Git log unavailable"Repository: clerk/javascript
Length of output: 88
🏁 Script executed:
# Check if there are any documentation or migration-related files that hint at route changes
fd -t f 'clerk-docs' . 2>/dev/null | head -10 || echo "No clerk-docs references found"Repository: clerk/javascript
Length of output: 42
🏁 Script executed:
# Search more broadly for the specific types/objects pattern in comments
rg 'billing-plan-resource' --type ts 2>/dev/null || rg 'billing-plan-resource' | head -20Repository: clerk/javascript
Length of output: 525
🌐 Web query:
site:clerk.com/docs/reference/types/billing-plan-resource
💡 Result:
The Clerk Docs page you’re looking for is the BillingPlanResource type reference (Clerk’s Billing “Plan” object). It’s available at https://clerk.com/docs/reference/javascript/types/billing-plan-resource. [1]
What BillingPlanResource contains (key properties): id, name, slug, description, avatarUrl, features (FeatureResource[]), pricing fields like fee (monthly), annualFee, annualMonthlyFee, trial fields like freeTrialEnabled and freeTrialDays, plus flags like isDefault, publiclyVisible, isRecurring, hasBaseFee, and forPayerType ("org" | "user"). [1]
🌐 Web query:
clerk clerk-docs 3185 billing plan resource new documentation routes
💡 Result:
PR #3185 in clerk/clerk-docs (draft as of Mar 11, 2026) is a JavaScript reference-docs revamp that changes documentation routes by: (1) moving object reference pages from /docs/reference/javascript/** → /docs/reference/objects/**, and (2) moving type reference pages from /docs/reference/javascript/types/** → /docs/reference/types/**, with redirects added so old links keep working. [1]
For BillingPlanResource specifically, the current live page is still under the old JavaScript types route: /docs/reference/javascript/types/billing-plan-resource (last updated Mar 4, 2026). [2] Under the PR’s plan, it would be reachable at /docs/reference/types/billing-plan-resource. [1]
Sources:
[1] PR #3185 description (route moves + redirects) clerk/clerk-docs#3185
[2] Current BillingPlanResource doc page https://clerk.com/docs/reference/javascript/types/billing-plan-resource
🌐 Web query:
site:clerk.com/docs/reference/types/billing-plan-resource
💡 Result:
The Clerk docs page you’re pointing to is BillingPlanResource (JavaScript Types). It defines the shape of a subscription plan object and includes these key properties: id, name, slug, description, avatarUrl, fee (monthly), annualFee, annualMonthlyFee, isDefault, publiclyVisible, forPayerType ("org" | "user"), isRecurring, hasBaseFee, plus free-trial fields freeTrialEnabled and freeTrialDays, and features: FeatureResource[]. (clerk.com)
Citations:
🌐 Web query:
clerk-docs PR 3185 merged deployed live March 2026 documentation routes /types /objects
💡 Result:
- PR status (clerk/clerk-docs
#3185): As of March 11, 2026, PR Nextjs 14, docker, production error: Failed to load Clerk #3185 is still a Draft and not merged intomain. (github.com) - Deployed? It has a Vercel preview deployment (e.g.
clerk-docs-git-aa-javascript-revamp.clerkstage.dev) updated Mar 11, 2026 10:01pm UTC, but that is not the live production docs site. (github.com) - Route changes proposed in the PR:
- Move object reference docs from
/docs/reference/javascript/**→/docs/reference/objects/**(github.com) - Move type reference docs from
/docs/reference/javascript/types/**→/docs/reference/types/**(github.com) - Add redirects for the moved routes. (github.com)
- Move object reference docs from
- What’s live on clerk.com right now: the types overview page is currently accessible under the JavaScript path (example:
/docs/reference/javascript/types/overview, “Last updated on Mar 6, 2026”). (clerk.com)
Citations:
- 1: WIP: JavaScript OVERHAUL REVAMP TAKEOVER WWE SMACKDOWN clerk-docs#3185
- 2: WIP: JavaScript OVERHAUL REVAMP TAKEOVER WWE SMACKDOWN clerk-docs#3185
- 3: WIP: JavaScript OVERHAUL REVAMP TAKEOVER WWE SMACKDOWN clerk-docs#3185
- 4: WIP: JavaScript OVERHAUL REVAMP TAKEOVER WWE SMACKDOWN clerk-docs#3185
- 5: WIP: JavaScript OVERHAUL REVAMP TAKEOVER WWE SMACKDOWN clerk-docs#3185
- 6: https://clerk.com/docs/reference/javascript/types/overview
🏁 Script executed:
# Search for all documentation link references being modified in this PR to assess scope
rg '/docs/reference/(types|objects)' packages/backend/src/api/resources/ -nRepository: clerk/javascript
Length of output: 5524
🏁 Script executed:
# Check broader codebase for organization-membership and sign-up doc links
rg 'organization-membership|sign-up' --type ts -n | grep 'docs/reference' | head -10Repository: clerk/javascript
Length of output: 2674
Block merge until clerk/clerk-docs#3185 is deployed.
This PR updates documentation links across ~10 files to point to the new /docs/reference/types/* and /docs/reference/objects/* routes (e.g., organization-membership, sign-up, billing-plan-resource). However, these new routes are not yet live—the referenced clerk-docs PR is still in draft status as of March 11, 2026. Merging now would replace working links (currently under /docs/reference/javascript/types/* and /docs/reference/objects/*) with non-existent ones. Wait for clerk/clerk-docs#3185 to be deployed and include redirects before merging.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/backend/src/api/resources/CommercePlan.ts` at line 7, The changes
replace working doc links with new routes that aren't live yet; stop this merge
and either revert the updated links back to the current working routes (e.g.,
the javascript/types and objects paths) or hold the PR until
clerk/clerk-docs#3185 is deployed with redirects; specifically, in the
CommercePlan.ts description referencing the `BillingPlan` object (and any other
files that now point to `/docs/reference/types/*` or
`/docs/reference/objects/*`), restore the original
`/docs/reference/javascript/types/*` and `/docs/reference/objects/*` links or
wait to update all links in one coordinated change once the docs PR is live.
|
|
||
| /** | ||
| * Returns the current [`SignUp`](https://clerk.com/docs/reference/javascript/sign-up) object which provides | ||
| * Returns the current [`SignUp`](https://clerk.com/docs/reference/objects/sign-up) object which provides |
There was a problem hiding this comment.
Gate this docs-link migration.
The new /docs/reference/objects/sign-up target currently returns 404, while the current SignUp reference is still published at /docs/reference/javascript/sign-up. Merging this rewrite now would ship a broken docs link. ()
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/vue/src/composables/useSignUp.ts` at line 12, The docs link in the
JSDoc for useSignUp.ts currently points to the new
/docs/reference/objects/sign-up which 404s; revert or gate that change by
updating the link text in the comment that starts with "Returns the current
[`SignUp`](" to use the existing published URL
/docs/reference/javascript/sign-up (or wrap the new URL behind a runtime/feature
flag if you prefer gating), so the comment references the live SignUp docs until
the new route is published.
|
This looks good! Just checking, is the plan to merge this PR, open a Typedoc PR, and then merge the |
yep! that's what we usually do, is that still the correct flow in your opinion? |
3 participants
Description
Clerk Docs is doing a revamp of the JavaScript reference docs, which requires many links changes.
Changes
/docs/references/javascript/types/**-->/docs/references/types/**Changes
/docs/references/javascript/**-->/docs/references/objects/**Related Docs PR: clerk/clerk-docs#3185
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
Documentation
Chores
Deprecations