Skip to content

docs: add NestJS tutorial #267

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.

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 4 commits into from
Mar 27, 2024
Merged

docs: add NestJS tutorial #267

merged 4 commits into from
Mar 27, 2024

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Mar 27, 2024

No description provided.

Copy link

vercel bot commented Mar 27, 2024

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 Mar 27, 2024 11:32pm

Copy link
Contributor

coderabbitai bot commented Mar 27, 2024

Warning

Rate Limit Exceeded

@ymc9 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 17 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between ec77afd and ec1df4e.

Walkthrough

The recent updates aim to enrich ZenStack's documentation and functionality. These enhancements include clarifying permission management through the @@allow attribute, refining user guidance, adjusting sidebar configurations, and introducing a new guide for integrating ZenStack with NestJS. Moreover, the updates ensure alignment with HTTP status code standards for data validation errors and expand syntax highlighting capabilities in documentation.

Changes

Files Change Summaries
docs/quick-start/_access-policy.md Updated the @@allow attribute description for improved permissions management understanding.
docs/quick-start/_zenstack-init-tips.md Changed the block type from "tip" to "info" for a specific command description.
docs/quick-start/backend.mdx Adjusted the sidebar position from 7 to 8.
docs/quick-start/nestjs.mdx Added a comprehensive integration guide for ZenStack with NestJS, covering various aspects.
docs/upgrade.md Switched to using HTTP status code 422 for data validation errors instead of 403 to adhere to standards.
docusaurus.config.js Included JSON language support in the Prism syntax highlighting configuration.

Possibly related issues

  • [Feature Request] ZenStack for API integration zenstack#563: The new NestJS integration guide and documentation enhancements align with the objectives of improving developer experience and extending ZenStack's capabilities beyond databases. This could contribute to the goals of a unified CRUD API style and access control mechanism as outlined in the issue.

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

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. 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 tests 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 tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@ymc9 ymc9 merged commit 0090e29 into main Mar 27, 2024
@ymc9 ymc9 deleted the docs/nestjs branch March 27, 2024 23:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant