EDU-16243 - Input review

[barbara-celi]

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)

[github-actions]

Navigation Preview Link

No changes detected in the navigation.json file

[github-actions]

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:

• Couldn't find the corresponding page for docs/faststore/components/atoms/input.mdx. Have you added input to the navigation.json file? Maybe you can find it in https://developers.vtex.com/docs/guides/faststore/atoms-input

[github-actions]

Grammar review summary

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

The review identified issues related to informal phrasing, incorrect pluralization of 'user input', missing capitalization for a component name, and a missing period at the end of a sentence. Corrections have been provided for clarity and grammatical accuracy.

---

Was this feedback useful?

• Yes
• No

[mariana-caetano]

Suggested change

	Disabled inputs use reduced opacity and distinct styling to indicate when an input field is temporarily unavailable for interaction, preventing user input while maintaining visual context.

[mariana-caetano]

Suggested change

	- Use placeholder text as a hint or example of the expected input format, not as a replacement for labels.
	- Ensure sufficient color contrast between text and background for accessibility.
	- Use appropriate input types (e.g., email, name, phone number) to trigger the correct keyboard on mobile devices.
	### ❌ Don'ts
	- Don't use vague or ambiguous labels that leave users uncertain about what information to provide.
	- Don't use inputs for long-form text entry. Use a [textarea](https://developers.vtex.com/docs/guides/faststore/atoms-textarea) component instead.
	- Don't disable inputs without providing a clear reason why they're unavailable.
	---

[github-actions]

Grammar review summary

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

The review identified issues related to conciseness, word choice (singular vs. plural for 'input'), and consistent component naming. Corrections include combining sentences for better flow and ensuring component names are properly formatted.

---

Was this feedback useful?

• Yes
• No

[github-actions]

📝 [Grammar reviewer] _{reported by reviewdog 🐶}
The two sentences can be combined for better flow and conciseness. Additionally, 'user inputs' should be singular 'user input' as it refers to a general concept.

Suggested change

	The `Input` component renders a single-line text field for capturing short user inputs. It serves as a means of collecting information from users. Typical use cases include:
	The `Input` component renders a single-line text field for capturing short user input, serving as a means of collecting information from users. Typical use cases include:

[github-actions]

📝 [Grammar reviewer] _{reported by reviewdog 🐶}
When referring to the specific component, it should be capitalized and enclosed in backticks for consistency with other component references in the document. Also, the indefinite article 'an' is needed before 'Input'.

dev-portal-content/docs/faststore/components/atoms/input.mdx

Line 173 in 5a7f222

- Provide a [Label](https://developers.vtex.com/docs/guides/faststore/atoms-label) when using input. Descriptive labels help users understand the purpose of a form control.