zenstackhq / zenstack-docs

ZenStack documentation
https://zenstack.dev
MIT License
9 stars 19 forks source link

docs: add clerk sample for app router; upgrade docusaurus to 3.4 #312

Closed ymc9 closed 4 months ago

ymc9 commented 4 months ago

Summary by CodeRabbit

vercel[bot] commented 4 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
zenstack-new-site ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2024 2:45am
coderabbitai[bot] commented 4 months ago

Walkthrough

The recent updates include restructuring the clerk.md documentation to demonstrate enhanced Prisma client setups within Next.js applications using Clerk authentication. Additionally, there were adjustments in the sidebar positions for quick-start guides in the Next.js documentation to improve navigation.

Changes

File Path Change Summary
docs/guides/authentication/clerk.md Added imports for Tabs and TabItem; restructured code within <Tabs> and <TabItem> components.
docs/quick-start/nextjs-app-router.mdx Updated sidebar_position from 2 to 1.
docs/quick-start/nextjs.mdx Updated sidebar_position from 1 to 2.

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 8d1f55684485c01c39e91267c95b4b1e8f93eb77 and 95635d9c25c84d3f529c12b4ee4db75a61a56bb9.
Files ignored due to path filters (2) * `package.json` is excluded by `!**/*.json` * `pnpm-lock.yaml` is excluded by `!pnpm-lock.yaml`, `!**/*.yaml`
Files selected for processing (3) * docs/guides/authentication/clerk.md (2 hunks) * docs/quick-start/nextjs-app-router.mdx (1 hunks) * docs/quick-start/nextjs.mdx (1 hunks)
Additional context used
LanguageTool
docs/guides/authentication/clerk.md
[uncategorized] ~20-~20: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA) Context: ...ick here is to mark the `User` model as ignored so Prisma doesn't map it to a database ...
docs/quick-start/nextjs.mdx
[uncategorized] ~206-~206: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA) Context: ...o you don't need to write it yourself. First install the `@zenstackhq/server` and `@... --- [uncategorized] ~338-~338: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA) Context: ...rned by the access policies we defined. Here the `create` call can succeed becaus...
docs/quick-start/nextjs-app-router.mdx
[uncategorized] ~263-~263: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE) Context: ...; you'll find the hooks generated under `/src/lib/hooks` folder: ```bash npx zen... --- [uncategorized] ~324-~324: The official spelling of this programming framework is “Next.js”. (NODE_JS) Context: ...m setup to get React Query to work with NextJS's app router. For more more in-depth ba... --- [grammar] ~324-~324: Use only “more” (without ‘more’) when you use the comparative. (MOST_COMPARATIVE) Context: ...y to work with NextJS's app router. For more more in-depth background and setup, please r...
Markdownlint
docs/guides/authentication/clerk.md
14-14: Expected: h2; Actual: h3 (MD001, heading-increment) Heading levels should only increment by one level at a time
Additional comments not posted (4)
docs/guides/authentication/clerk.md (2)
`7-8`: Ensure that the newly added imports for `Tabs` and `TabItem` are utilized within the document. --- `56-93`: The example code for integrating Clerk with Prisma is clear and well-documented. Ensure that the `auth()` function and the `enhance` method are properly defined and imported in your project.
docs/quick-start/nextjs.mdx (1)
`4-4`: The change in `sidebar_position` from 1 to 2 is noted. Ensure this change reflects the intended navigation order in the sidebar.
docs/quick-start/nextjs-app-router.mdx (1)
`4-4`: The update in `sidebar_position` from 2 to 1 is appropriate to prioritize this guide in the sidebar navigation.
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): > :bangbang: **IMPORTANT** > Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged. - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.