docs: doc changes for release 2.5.0 #361
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe documentation for ZenStack has been updated to clarify limitations regarding API compatibility with edge runtime environments, enhance guidance for using tRPC with different versions, introduce a new command for schema validation in the CLI, and provide details on integrating ZenStack with Prisma Pulse. Additionally, improvements have been made to the Changes
Recent review detailsConfiguration used: CodeRabbit UI Files selected for processing (8)
Files skipped from review due to trivial changes (1)
Additional context usedLanguageTool
Markdownlint
Additional comments not posted (8)
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}
| | generateModels | String, String[] | Array or comma separated string for the models to generate routers for. | No | All models | | ||
| | version | String | tRPC version to target - "v10" or "v11". "v11" support is still in preview. | No | v10 | | ||
| | importCreateRouter | String | Only needed when "version" is set to "v11". This option tells the code generator where to import the `createTRPCRouter` tRPC router factory object from. | Yes (v11) | | | ||
| | importProcedure | String | Only needed when "version" is set to "v11". This option tells the code generator where to import the `procedure` tRPC procedure factory object from. | Yes (v11) | || generateModels | String, String[] | Array or comma separated string for the models to generate routers for. | No | All models | |
There was a problem hiding this comment.
Fix required: Table format issue.
The table has too many cells as per the Markdownlint warning. Please ensure that the table format is corrected to display all data properly.
Tools
Markdownlint
29-29: Expected: 5; Actual: 11; Too many cells, extra data will be missing
Table column count(MD056, table-column-count)
| You can use the `@@validate` attribute to attach validation rules to a model. Use the `message` parameter to provide an optional custom error message, and the `path` parameter to provide an optional path to the field that caused the error. | ||
|
|
||
| ``` | ||
| @@validate(_ value: Boolean, _ message: String?) | ||
| @@validate(_ value: Boolean, _ message: String?, _ path: String[]?) |
There was a problem hiding this comment.
Approve the enhancements to the @@validate attribute and suggest Markdown formatting fix.
The updates to the @@validate attribute documentation are clear and align with the PR objectives, enhancing the usability of the validation mechanism by introducing message and path parameters.
However, there's a minor issue with the Markdown formatting:
- The fenced code block at line 1648 is missing a language specification, which is important for proper syntax highlighting and readability.
Please add a language specification to the fenced code block to resolve the Markdownlint warning. Here's a suggested fix:
- ```
+ ```zmodel
@@validate(_ value: Boolean, _ message: String?, _ path: String[]?)Tools
Markdownlint
1648-1648: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Summary by CodeRabbit
New Features
checkcommand to the CLI for schema validation.Documentation Updates
@@validateattribute documentation with new parameters for better error handling.