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 🪧 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: |
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