doc:Fix typo in form validation documentation#40163
doc:Fix typo in form validation documentation#40163Pavani12314 wants to merge 1 commit intoRocketChat:developfrom
Conversation
|
Looks like this PR is not ready to merge, because of the following issues:
Please fix the issues and try again If you have any trouble, please check the PR guidelines |
|
WalkthroughA minor documentation update to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Updates the form validation guidelines documentation to correct wording in the “Overview” bullet list.
Changes:
- Adjusted the UX-related bullet under “The form validation standardization aims to:” in
docs/form-validation.md.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| The form validation standardization aims to: | ||
| - **Improve accessibility** by keeping submit buttons enabled and letting validation run on submit | ||
| - **Provide consistent UX** with validation triggered on form submission and re-validation on field changes | ||
| - **Provide a consistent UX with validation triggered on form submission and re-validation on field changes. |
There was a problem hiding this comment.
This bullet’s Markdown formatting is broken: the bold marker (**) is opened but never closed, so the rest of the list may render incorrectly. Please restore the intended pattern (e.g., bold only the short heading like “Provide consistent UX”, then keep the explanatory text outside the bold) and align punctuation with the surrounding bullets.
| - **Provide a consistent UX with validation triggered on form submission and re-validation on field changes. | |
| - **Provide a consistent UX** with validation triggered on form submission and re-validation on field changes. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/form-validation.md`:
- Line 9: The bullet text that begins with "**Provide a consistent UX with
validation triggered on form submission and re-validation on field changes." has
an unclosed bold marker; fix it by closing the bold markers so only the lead
phrase is bold (e.g., surround "Provide a consistent UX" with ** ... **) and
leave the remainder of the sentence unbolded, updating the line that currently
starts with the unclosed ** to include the closing ** after the lead phrase.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 80d8bd38-25bb-4b0a-acd5-bab5cfd97398
📒 Files selected for processing (1)
docs/form-validation.md
📜 Review details
⏰ 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). (1)
- GitHub Check: cubic · AI code reviewer
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: amitb0ra
Repo: RocketChat/Rocket.Chat PR: 39676
File: .changeset/migrate-users-register-openapi.md:3-3
Timestamp: 2026-03-16T21:50:42.118Z
Learning: In RocketChat/Rocket.Chat OpenAPI migration PRs, removing endpoint types and validators from `rocket.chat/rest-typings` (e.g., `UserRegisterParamsPOST`, `/v1/users.register` entry) is the *required* migration pattern per RocketChat/Rocket.Chat-Open-API#150 Rule 7 ("No More rest-typings or Manual Typings"). The endpoint type is re-exposed via a module augmentation `.d.ts` file in the consuming package (e.g., `packages/web-ui-registration/src/users-register.d.ts`). This is NOT a breaking change — the correct changeset bump for `rocket.chat/rest-typings` in this scenario is `minor`, not `major`. Do not flag this as a breaking change during OpenAPI migration reviews.
Learnt from: amitb0ra
Repo: RocketChat/Rocket.Chat PR: 39647
File: apps/meteor/app/api/server/v1/users.ts:710-757
Timestamp: 2026-03-15T14:31:28.969Z
Learning: In RocketChat/Rocket.Chat, the `UserCreateParamsPOST` type in `apps/meteor/app/api/server/v1/users.ts` (migrated from `packages/rest-typings/src/v1/users/UserCreateParamsPOST.ts`) intentionally has `fields: string` (non-optional) and `settings?: IUserSettings` without a corresponding AJV schema entry. This is a pre-existing divergence carried over verbatim from the original rest-typings source (PR `#39647`). Do not flag this type/schema misalignment during the OpenAPI migration review — it is tracked as a separate follow-up fix.
| The form validation standardization aims to: | ||
| - **Improve accessibility** by keeping submit buttons enabled and letting validation run on submit | ||
| - **Provide consistent UX** with validation triggered on form submission and re-validation on field changes | ||
| - **Provide a consistent UX with validation triggered on form submission and re-validation on field changes. |
There was a problem hiding this comment.
Fix unclosed bold marker in bullet text.
Line 9 opens ** but never closes it, so markdown emphasis is malformed. Please close bold around the lead phrase only.
✏️ Proposed fix
-- **Provide a consistent UX with validation triggered on form submission and re-validation on field changes.
+- **Provide a consistent UX** with validation triggered on form submission and re-validation on field changes.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **Provide a consistent UX with validation triggered on form submission and re-validation on field changes. | |
| - **Provide a consistent UX** with validation triggered on form submission and re-validation on field changes. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/form-validation.md` at line 9, The bullet text that begins with
"**Provide a consistent UX with validation triggered on form submission and
re-validation on field changes." has an unclosed bold marker; fix it by closing
the bold markers so only the lead phrase is bold (e.g., surround "Provide a
consistent UX" with ** ... **) and leave the remainder of the sentence unbolded,
updating the line that currently starts with the unclosed ** to include the
closing ** after the lead phrase.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 issue found across 1 file
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/form-validation.md">
<violation number="1" location="docs/form-validation.md:9">
P3: Malformed Markdown emphasis in overview bullet: opening `**` is missing a closing `**`.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
| The form validation standardization aims to: | ||
| - **Improve accessibility** by keeping submit buttons enabled and letting validation run on submit | ||
| - **Provide consistent UX** with validation triggered on form submission and re-validation on field changes | ||
| - **Provide a consistent UX with validation triggered on form submission and re-validation on field changes. |
There was a problem hiding this comment.
P3: Malformed Markdown emphasis in overview bullet: opening ** is missing a closing **.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/form-validation.md, line 9:
<comment>Malformed Markdown emphasis in overview bullet: opening `**` is missing a closing `**`.</comment>
<file context>
@@ -6,7 +6,7 @@ This document outlines the standardized form validation patterns and guidelines
The form validation standardization aims to:
- **Improve accessibility** by keeping submit buttons enabled and letting validation run on submit
-- **Provide consistent UX** with validation triggered on form submission and re-validation on field changes
+- **Provide a consistent UX with validation triggered on form submission and re-validation on field changes.
- **Prevent unnecessary API calls** by using dirty-checks and appropriate revalidation modes
- **Enhance user feedback** with clear error messages and proper ARIA attributes
</file context>
| - **Provide a consistent UX with validation triggered on form submission and re-validation on field changes. | |
| - **Provide a consistent UX** with validation triggered on form submission and re-validation on field changes. |
Pavani12314
changed the title
Description
Fixes a small typo in documentation.
Changes
Notes
This is a minor documentation improvement.
Summary by CodeRabbit