Skip to content

docs(repo): Add link replacements for broken hash in useOrganizationList returns #6965

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 13, 2025
Merged

docs(repo): Add link replacements for broken hash in useOrganizationList returns #6965

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
911c55c
Add link replacements for broken hash in useOrganizationList returns
SarahSoutoul Oct 10, 2025
c9ce587
Merge branch 'main' into ss/fix-broken-link-use-organization-list-hook
SarahSoutoul Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .typedoc/custom-plugin.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ const LINK_REPLACEMENTS = [
['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'],
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 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.

['session-resource', '/docs/reference/javascript/session'],
['signed-in-session-resource', '/docs/reference/javascript/session'],
['sign-in-resource', '/docs/reference/javascript/sign-in'],
Expand Down