docs(repo): Update typedoc guides #6353
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
📝 WalkthroughWalkthroughThe changes update documentation files to correct the referenced destination repository for generated Typedoc documentation. The previous documentation stated that generated docs were pushed to the Estimated code review effort1 (~5 minutes) 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/CONTRIBUTING.md (1)
183-186: Typo in folder name two lines aboveLine 183 still references
.typdoc/docs(missing the e). Fixing it prevents confusion for new contributors.- Locally, you can run `pnpm run typedoc:generate` to generate the docs. Afterwards, you can inspect the MDX files inside `.typdoc/docs`. + Locally, you can run `pnpm run typedoc:generate` to generate the docs. Afterwards, you can inspect the MDX files inside `.typedoc/docs`.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.typedoc/README.md(1 hunks)docs/CICD.md(1 hunks)docs/CONTRIBUTING.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}
Instructions used from:
Sources:
📄 CodeRabbit Inference Engine
- .cursor/rules/development.mdc
docs/**/*
Instructions used from:
Sources:
📄 CodeRabbit Inference Engine
- .cursor/rules/monorepo.mdc
**/*
Instructions used from:
Sources:
⚙️ CodeRabbit Configuration File
🧠 Learnings (1)
docs/CONTRIBUTING.md (1)
Learnt from: CR
PR: clerk/javascript#0
File: docs/CONTRIBUTING.md:0-0
Timestamp: 2025-07-18T15:23:03.087Z
Learning: If you find a typo in a Typedoc-generated file, edit the source file and open a PR to merge the fix to `main`.
⏰ 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). (5)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: Build Packages
- GitHub Check: semgrep/ci
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (2)
.typedoc/README.md (1)
74-75: Looks good – please double-check CI configurationThe repository path has been updated correctly. Ensure the GH Actions job that pushes
./.typedoc/docshas already been switched toclerk/clerk-docs/clerk-typedoc; otherwise CI will still open PRs against the old repository.docs/CICD.md (1)
17-18: LGTM – destination repo updatedThe workflow-dispatch target now points at
clerk/clerk-docs, matching the other docs.
@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: |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/CONTRIBUTING.md (1)
185-185: Use the American-English variant “afterward”House style (and LanguageTool) flags “Afterwards” as UK usage. Swap it for “afterward” for consistency.
-...generate the docs. Afterwards, you can inspect the MDX files... +...generate the docs. Afterward, you can inspect the MDX files...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/CONTRIBUTING.md(1 hunks)
📓 Path-based instructions (3)
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
docs/CONTRIBUTING.md
docs/**/*
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Documentation and contribution guides must be located in the 'docs/' directory.
Files:
docs/CONTRIBUTING.md
**/*
⚙️ CodeRabbit Configuration File
**/*: If there are no tests added or modified as part of the PR, please suggest that tests be added to cover the changes.Whenever reviewing a pull request, if there are any changes that could impact security, always tag
clerk/securityin the PR.Security-impacting changes include, but are not limited to:
- Changes to authentication logic or mechanisms (e.g. login, session handling, token issuance)
- Any modification to access control, authorization checks, or role-based permissions
- Introduction or modification of hashing algorithms, signature verification, or cryptographic primitives
- Handling of sensitive data (e.g. passwords, tokens, secrets, PII)
- Integration with external identity providers (e.g. SSO, OAuth, OpenID Connect)
- Modifications to security headers, cookie flags, CORS policies, or CSRF protections
- Bypass mechanisms (e.g. feature flags, testing overrides) that could weaken protections
- Changes to rate limiting, abuse prevention, or input validation
If you're unsure whether a change is security-relevant, err on the side of caution and tag
clerk/security.Any time that you tag
clerk/security, please do so explicitly in a code comment, rather than within a collapsed section in a coderabbit comment, such as the "recent review details" section. If you do use the team name in any thinking or non-direct-code-comment content, it can be referred to as "clerk security team" to avoid accidentally printing the tag which sends a notification to the team.
Files:
docs/CONTRIBUTING.md
🪛 LanguageTool
docs/CONTRIBUTING.md
[locale-violation] ~185-~185: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...typedoc:generateto generate the docs. Afterwards, you can inspect the MDX files inside...
(AFTERWARDS_US)
🧰 Additional context used
📓 Path-based instructions (3)
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
docs/CONTRIBUTING.md
docs/**/*
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Documentation and contribution guides must be located in the 'docs/' directory.
Files:
docs/CONTRIBUTING.md
**/*
⚙️ CodeRabbit Configuration File
**/*: If there are no tests added or modified as part of the PR, please suggest that tests be added to cover the changes.Whenever reviewing a pull request, if there are any changes that could impact security, always tag
clerk/securityin the PR.Security-impacting changes include, but are not limited to:
- Changes to authentication logic or mechanisms (e.g. login, session handling, token issuance)
- Any modification to access control, authorization checks, or role-based permissions
- Introduction or modification of hashing algorithms, signature verification, or cryptographic primitives
- Handling of sensitive data (e.g. passwords, tokens, secrets, PII)
- Integration with external identity providers (e.g. SSO, OAuth, OpenID Connect)
- Modifications to security headers, cookie flags, CORS policies, or CSRF protections
- Bypass mechanisms (e.g. feature flags, testing overrides) that could weaken protections
- Changes to rate limiting, abuse prevention, or input validation
If you're unsure whether a change is security-relevant, err on the side of caution and tag
clerk/security.Any time that you tag
clerk/security, please do so explicitly in a code comment, rather than within a collapsed section in a coderabbit comment, such as the "recent review details" section. If you do use the team name in any thinking or non-direct-code-comment content, it can be referred to as "clerk security team" to avoid accidentally printing the tag which sends a notification to the team.
Files:
docs/CONTRIBUTING.md
🪛 LanguageTool
docs/CONTRIBUTING.md
[locale-violation] ~185-~185: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...typedoc:generateto generate the docs. Afterwards, you can inspect the MDX files inside...
(AFTERWARDS_US)
⏰ 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). (4)
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: Build Packages
- GitHub Check: semgrep/ci
- GitHub Check: Analyze (javascript-typescript)
| For a comprehensive guide on **authoring** JSDoc/Typedoc comments, see [this guide](https://www.notion.so/clerkdev/Typedoc-JSDoc-1df2b9ab44fe808a8cf2c9cca324ea89?source=copy_link). | ||
|
|
There was a problem hiding this comment.
Replace private Notion link with a publicly accessible resource
The Notion link is likely inaccessible to external contributors, breaking the CONTRIBUTING guide for the majority of the OSS audience. Please swap it for a public URL (e.g. a section in clerk-docs).
-For a comprehensive guide on **authoring** JSDoc/Typedoc comments, see [this guide](https://www.notion.so/clerkdev/Typedoc-JSDoc-1df2b9ab44fe808a8cf2c9cca324ea89?source=copy_link).
+For a comprehensive guide on **authoring** JSDoc/Typedoc comments, see the [Typedoc authoring section in the clerk-docs CONTRIBUTING guide](https://github.com/clerk/clerk-docs/blob/main/CONTRIBUTING.md#typedoc-).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| For a comprehensive guide on **authoring** JSDoc/Typedoc comments, see [this guide](https://www.notion.so/clerkdev/Typedoc-JSDoc-1df2b9ab44fe808a8cf2c9cca324ea89?source=copy_link). | |
| For a comprehensive guide on **authoring** JSDoc/Typedoc comments, see the [Typedoc authoring section in the clerk-docs CONTRIBUTING guide](https://github.com/clerk/clerk-docs/blob/main/CONTRIBUTING.md#typedoc-). |
🤖 Prompt for AI Agents
In docs/CONTRIBUTING.md around lines 183 to 184, replace the private Notion link
with a publicly accessible URL to ensure external contributors can access the
guide. Find or create a public resource, such as a section in clerk-docs, that
covers authoring JSDoc/Typedoc comments and update the link accordingly.
Description
I've moved the generated files to be directly in the
clerk-docsrepo. Updating the documentation in this repo to reflect that.Alongside these prs to update the guides in those relevant places.
clerk/clerk-docs#2437
https://github.com/clerk/clerk/pull/1399
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit