docs: v2.6.0 release #369
docs: v2.6.0 release #369
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe pull request introduces enhancements to the documentation for the tRPC and ZenStack plugins. It clarifies how to specify non-top-level paths for TRPC procedures in the Changes
Possibly related PRs
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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
Outside diff range and nitpick comments (2)
docs/reference/plugins/trpc.md (1)
104-113: LGTM! Consider a minor enhancement for clarity.The added informational note is valuable and well-presented. It clearly explains how to handle non-top-level paths for generated TRPC procedures, which is an important consideration for some users.
To further enhance clarity, consider adding a brief explanation of why a user might need to install procedures at a non-top-level path. This context could help users better understand when they might need to use this feature. For example:
:::info -If your generated trpc procedures are installed at a non-top-level path, you can specify the path with the second type parameter of the `createTRPCNext` or `createTRPCReact` function. +If your generated trpc procedures are installed at a non-top-level path (e.g., when organizing a large API surface), you can specify the path with the second type parameter of the `createTRPCNext` or `createTRPCReact` function. ```ts // if the generated procedures are installed at `/crud` under the router treedocs/reference/plugins/zod.md (1)
160-160: LGTM! Consider adding a brief explanation for each mode.The new
modeoption is well-documented and properly integrated into the options table. The description, possible values, and default value are clearly stated.To enhance clarity, consider adding a brief explanation for each mode value. For example:
| mode | String | Controls how the generated schemas handle unknown fields. Possible values: "strict" (reject unknown fields), "strip" (remove unknown fields), "passthrough" (allow unknown fields) | No | "strict" |
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/reference/plugins/trpc.md (1 hunks)
- docs/reference/plugins/zod.md (1 hunks)
Additional comments not posted (1)
docs/reference/plugins/zod.md (1)
Line range hint
1-160: Documentation update for the newmodeoption looks good!The addition of the
modeoption to the @core/zod plugin configuration enhances its functionality by providing users with more control over how generated schemas handle unknown fields. This update is well-integrated into the existing documentation and maintains consistency with the overall structure and style of the file.
Summary by CodeRabbit
New Features
modeoption in the ZenStack plugin configuration to control schema handling of unknown fields.Documentation
modeoption for ZenStack.