docs(repo): Add link replacements for broken hash in useOrganizationList returns #6965
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughA new link replacement entry was added to .typedoc/custom-plugin.mjs to map references to create-organization-params to the in-page anchor #create-organization-params within the relative link rewrite logic. No other logic or control flow was modified. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant TypeDoc
participant CustomPlugin
participant LinkRewriter
TypeDoc->>CustomPlugin: Process doc page
CustomPlugin->>LinkRewriter: Rewrite relative links
Note right of LinkRewriter: Check LINK_REPLACEMENTS map
alt Match "create-organization-params"
LinkRewriter-->>CustomPlugin: Replace with "#create-organization-params"
else Other links
LinkRewriter-->>CustomPlugin: Apply existing rules/leave as-is
end
CustomPlugin-->>TypeDoc: Return transformed content
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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 |
@clerk/agent-toolkit
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/dev-cli
@clerk/elements
@clerk/clerk-expo
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/localizations
@clerk/nextjs
@clerk/nuxt
@clerk/clerk-react
@clerk/react-router
@clerk/remix
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/themes
@clerk/types
@clerk/upgrade
@clerk/vue
commit: |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
.typedoc/custom-plugin.mjs(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)
- GitHub Check: Integration Tests (localhost, chrome)
- GitHub Check: Integration Tests (sessions, chrome)
- GitHub Check: Integration Tests (sessions:staging, chrome)
- GitHub Check: Publish with pkg-pr-new
- GitHub Check: Unit Tests (22, **)
- GitHub Check: Unit Tests (18, --filter=@clerk/astro --filter=@clerk/backend --filter=@clerk/express --filter=@c...
- GitHub Check: Static analysis
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: Analyze (javascript-typescript)
| ['set-active-params', '/docs/reference/javascript/types/set-active-params'], | ||
| ['clerk-paginated-response', '/docs/reference/javascript/types/clerk-paginated-response'], | ||
| ['paginated-resources', '#paginated-resources'], | ||
| ['create-organization-params', '#create-organization-params'], |
There was a problem hiding this comment.
🧩 Analysis chain
LGTM! Consistent with existing in-page anchor pattern.
The addition correctly maps create-organization-params to an in-page anchor, consistent with similar entries like paginated-resources (line 31) and public-organization-data-json (line 49). Since create-organization-params.mdx is also listed in FILES_WITHOUT_HEADINGS (line 17), using an in-page anchor is appropriate.
Verify that the #create-organization-params anchor exists on the target documentation page where this file will be embedded, to ensure links resolve correctly.
🏁 Script executed:
#!/bin/bash
# Description: Verify that create-organization-params.mdx is referenced and the anchor context is clear
# Search for files that might embed or reference create-organization-params
echo "=== Searching for references to create-organization-params ==="
rg -n --type=mdx -C3 'create-organization-params' || echo "No .mdx files found (checking other formats...)"
echo -e "\n=== Searching in JavaScript/TypeScript files ==="
rg -n --type=js --type=ts -C3 'create-organization-params'
echo -e "\n=== Checking for anchor usage in MDX files ==="
rg -n '#create-organization-params' || echo "No anchor references found"Length of output: 263
🏁 Script executed:
#!/bin/bash
# Locate the MDX file and check for markdown headings (#) to confirm anchor generation
echo "=== Finding create-organization-params.mdx ==="
rg -l --glob '*create-organization-params.mdx' || echo "File not found"
echo -e "\n=== Checking for markdown headings in that file ==="
rg -n --glob '*create-organization-params.mdx' '^#+' || echo "No headings found"Length of output: 678
🏁 Script executed:
#!/bin/bash
# Locate the MDX file
echo "=== Locating create-organization-params.mdx ==="
file=$(find . -type f -name 'create-organization-params.mdx')
if [ -z "$file" ]; then
echo "File not found"
exit 0
fi
echo "Found file: $file"
# Check for markdown headings to confirm anchor generation
echo -e "\n=== Checking for markdown headings in $file ==="
rg -n '^#+' "$file" || echo "No markdown headings found"Length of output: 62
Invalid LINK_REPLACEMENTS entry: missing target file/anchor
No create-organization-params.mdx or corresponding #create-organization-params heading was found in the repo. Add the MDX file with the proper heading to generate this anchor, or remove/update this mapping.
🤖 Prompt for AI Agents
In .typedoc/custom-plugin.mjs around line 32, the LINK_REPLACEMENTS entry
"['create-organization-params', '#create-organization-params']" points to a
non-existent MDX anchor; either add a create-organization-params.mdx file
containing a heading with id or text that generates the
"#create-organization-params" anchor, or remove/update this mapping to reference
an existing MDX file/anchor; ensure the anchor name matches exactly (including
casing and hyphens) and regenerate docs to verify the link resolves.
2 participants
Description
While working on hooks, I noticed a bug on the live site with the
createOrganizationreturn type for theuseOrganizationListhook. Clicking onCreateOrganizationParamsled to a 404. This PR fixes it.Before:
Screen.Recording.2025-10-10.at.4.46.55.pm.mov
After:
Screen.Recording.2025-10-10.at.4.47.34.pm.mov
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit