docs(shared): fix broken Clerk docs links in organization JSDoc#8825
Conversation
The JSDoc-linked URLs for `organization-invitation`, `organization-suggestion`, and the `Organization` reference page all 404'd because they used the old un-hyphenated slugs and `types/organization` instead of `objects/organization`. Hover docs in IDEs now resolve to the correct pages. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: 13d81f2 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 |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Repository UI (inherited) Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThis PR updates JSDoc links in organization-related type definitions to hyphenated documentation paths, adds a changeset recording those edits, and reformats a few billing JSDoc comment lines without changing any types or runtime behavior. ChangesOrganization JSDoc Link Corrections
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
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 |
Comments-only change; no package patch needed. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@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: |
API Changes Report
Summary
No API Changes DetectedAll packages have stable APIs with no detected changes. Report generated by Break Check Last ran on |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
packages/shared/src/types/organizationDomain.ts (1)
83-83:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winMissed broken link: Line 83 still uses the old
organizationsuggestionslug.Line 83 references
https://clerk.com/docs/reference/types/organizationsuggestion, which is the old non-hyphenated slug. This should be updated toorganization-suggestionto match the fix applied at line 135 and align with the existing hyphenated format used inorganizationSuggestion.ts.📝 Proposed fix
/** - * The total number of pending [suggestions](https://clerk.com/docs/reference/types/organizationsuggestion) associated with this domain. + * The total number of pending [suggestions](https://clerk.com/docs/reference/types/organization-suggestion) associated with this domain. */Based on coding guidelines, JSDoc on public APIs is customer-facing documentation that may render in generated Clerk Docs. This link correction aligns with the PR's objective to fix broken documentation URLs.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/shared/src/types/organizationDomain.ts` at line 83, Update the broken JSDoc URL in the organization domain type: locate the JSDoc comment in packages/shared/src/types/organizationDomain.ts that contains the link "https://clerk.com/docs/reference/types/organizationsuggestion" (the doc comment describing pending suggestions) and replace that slug with the hyphenated form "https://clerk.com/docs/reference/types/organization-suggestion" so it matches the fixed link used elsewhere (e.g., organizationSuggestion.ts).Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@packages/shared/src/types/organizationDomain.ts`:
- Line 83: Update the broken JSDoc URL in the organization domain type: locate
the JSDoc comment in packages/shared/src/types/organizationDomain.ts that
contains the link
"https://clerk.com/docs/reference/types/organizationsuggestion" (the doc comment
describing pending suggestions) and replace that slug with the hyphenated form
"https://clerk.com/docs/reference/types/organization-suggestion" so it matches
the fixed link used elsewhere (e.g., organizationSuggestion.ts).
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: f5d2b045-1600-4c35-8f87-4563c8244e7b
📒 Files selected for processing (4)
.changeset/fix-organization-jsdoc-links.mdpackages/shared/src/types/organizationDomain.tspackages/shared/src/types/organizationMembership.tspackages/shared/src/types/organizationSettings.ts
CI format:check was failing on union type member indentation. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2 participants
Summary
types/organizationinvitation→types/organization-invitation,types/organizationsuggestion→types/organization-suggestion, andtypes/organization→objects/organization.OrganizationDomainResource,OrganizationMembershipResource,OrganizationSettingsResource, andUpdateEnrollmentModeParams.Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit