docs(repo): Add link replacements for broken types #6908
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughAdded two link replacement mappings to LINK_REPLACEMENTS in .typedoc/custom-plugin.mjs to expand relative link rewrites. No other logic or control flow changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks
✅ Passed checks (1 passed)
✨ Finishing touches
🧪 Generate unit tests
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: 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). (29)
- GitHub Check: Integration Tests (tanstack-react-router, chrome)
- GitHub Check: Integration Tests (nextjs, chrome, 14)
- GitHub Check: Integration Tests (react-router, chrome)
- GitHub Check: Integration Tests (nextjs, chrome, 15)
- GitHub Check: Integration Tests (billing, chrome)
- GitHub Check: Integration Tests (custom, chrome)
- GitHub Check: Integration Tests (sessions, chrome)
- GitHub Check: Integration Tests (nuxt, chrome)
- GitHub Check: Integration Tests (astro, chrome)
- GitHub Check: Integration Tests (machine, chrome)
- GitHub Check: Integration Tests (tanstack-react-start, chrome)
- GitHub Check: Integration Tests (expo-web, chrome)
- GitHub Check: Integration Tests (elements, chrome)
- GitHub Check: Integration Tests (handshake:staging, chrome)
- GitHub Check: Integration Tests (vue, chrome)
- GitHub Check: Integration Tests (express, chrome)
- GitHub Check: Integration Tests (localhost, chrome)
- GitHub Check: Integration Tests (sessions:staging, chrome)
- GitHub Check: Integration Tests (handshake, chrome)
- GitHub Check: Integration Tests (quickstart, chrome)
- GitHub Check: Integration Tests (generic, chrome)
- GitHub Check: Integration Tests (ap-flows, chrome)
- GitHub Check: Unit Tests (22, **)
- GitHub Check: Unit Tests (18, --filter=@clerk/astro --filter=@clerk/backend --filter=@clerk/express --filter=@c...
- GitHub Check: Publish with pkg-pr-new
- GitHub Check: Static analysis
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
| * Ideally this is a temporary solution until every one of these files are published in production and can be linked to. | ||
| */ | ||
| const LINK_REPLACEMENTS = [ | ||
| ['set-active-params', '/docs/reference/javascript/types/set-active-params'], |
There was a problem hiding this comment.
🧩 Analysis chain
LGTM! Link mappings are consistent with existing patterns.
The new entries follow the established conventions:
set-active-paramscorrectly maps to the/types/path as a type referencesign-in-resourcecorrectly maps without/types/as a resource reference, consistent withsign-up-resourceanduser-resource
Please verify that the target documentation pages exist or will be created:
Also applies to: 34-34
🏁 Script executed:
#!/bin/bash
# Description: Verify the target documentation paths exist in the repository
# Search for the target documentation files that should exist for these links
fd -t f "set-active-params" --extension md --extension mdx
fd -t f "sign-in" --extension md --extension mdx | grep -E "(sign-in\.mdx?|sign-in/index\.mdx?)$"Length of output: 34
Missing documentation targets for new link mappings
The following target pages do not exist in the repo and will result in broken links:
/docs/reference/javascript/types/set-active-params/docs/reference/javascript/sign-in
Add these documentation files or update the mappings accordingly.
🤖 Prompt for AI Agents
In .typedoc/custom-plugin.mjs around line 29, the plugin adds link mappings for
'/docs/reference/javascript/types/set-active-params' and
'/docs/reference/javascript/sign-in' but those target pages don't exist, causing
broken links; fix by either creating the missing documentation files at those
paths with appropriate content and frontmatter, or update the mapping array to
point to existing doc paths (or remove the entries) and ensure any build/test
referencing these mappings is updated accordingly so no broken links remain.
There was a problem hiding this comment.
Docs pages are loaded from the clerk/clerk-docs repo
There was a problem hiding this comment.
@NWylynko, thank you for the clarification! I understand now that the documentation pages are served from the clerk/clerk-docs repository, so the target paths /docs/reference/javascript/types/set-active-params and /docs/reference/javascript/sign-in would exist there rather than in this repository.
My apologies for the confusion. The link mappings in this PR are correctly configured for the multi-repo documentation setup. The generated type documentation from this repo will properly link to the published documentation in the docs repository.
✏️ Learnings added
Learnt from: NWylynko
PR: clerk/javascript#6908
File: .typedoc/custom-plugin.mjs:29-29
Timestamp: 2025-10-02T19:20:07.024Z
Learning: In the clerk/javascript repository, documentation pages referenced in LINK_REPLACEMENTS array in `.typedoc/custom-plugin.mjs` are served from the separate `clerk/clerk-docs` repository, not from the current repository. The type documentation generated in clerk/javascript links to paths that exist in the published docs site.
Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.
@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: |
2 participants
Description
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit