Skip to content

Conversation

mariana-caetano
Copy link
Contributor

Types of changes

  • New content (guides, endpoints, app documentation)
  • Improvement (make a documentation even better)
  • Fix (fix a documentation error)
  • Spelling and grammar accuracy (self-explanatory)

Copy link
Contributor

Navigation Preview Link

No changes detected in the navigation.json file

Copy link
Contributor

Preview Links

Open this URL to set up the portal with this branch changes.

You can now access the edited pages with the following URLs:

Copy link
Contributor

Grammar review summary

Review for docs/faststore/components/atoms/label.mdx

One grammatical issue was identified and corrected for improved clarity and conciseness in the introductory description of a label.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

Grammar review summary

Review for docs/faststore/components/atoms/label.mdx

Two minor grammatical issues were found: a missing period for consistency in a bulleted list and a phrase that could be reworded for better clarity and formality.


Was this feedback useful?

  • Yes
  • No


- Describing the purpose of input fields (e.g., `Email Address`, `Password`, or `Phone Number`).
- Associating descriptive text with form elements for improved accessibility.
- Providing context for user interactions in forms and surveys
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [Grammar reviewer] reported by reviewdog 🐶
For consistency with the other bullet points in this list (lines 14 and 15), a period should be added at the end of the phrase.

Suggested change
- Providing context for user interactions in forms and surveys
- Providing context for user interactions in forms and surveys.

### ❌ Don'ts

- Don't use placeholder text as a substitute for labels, as placeholders disappear when users start typing.
- Don't hide labels visually while keeping them only for screen readers.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [Grammar reviewer] reported by reviewdog 🐶
The phrasing 'keeping them only for screen readers' is slightly informal. 'Making them accessible only to screen readers' is clearer and more precise in technical documentation.

Suggested change
- Don't hide labels visually while keeping them only for screen readers.
- Don't hide labels visually while making them accessible only to screen readers.

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