Skip to content

Conversation

mariana-caetano
Copy link
Contributor

@mariana-caetano mariana-caetano commented Aug 15, 2025

This PR updates and improves the code examples for Button, and also revises the guides section:

  • Adds two new sections: Default usage and Examples.
  • Corrects the code examples to be more realistic and ready for use.
  • Separates the component variants.

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)

@mariana-caetano mariana-caetano self-assigned this Aug 15, 2025
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

github-actions bot commented Aug 15, 2025

Grammar review summary

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

The document is well-written with only a few minor grammatical and stylistic issues. Corrections primarily address capitalization inconsistencies, informal phrasing, and precise word choice to enhance clarity and adherence to standard technical documentation practices.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

Grammar review summary

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

The document is generally well-written with only a few minor capitalization, pluralization, and pronoun usage issues. The suggested corrections aim to improve consistency and grammatical precision.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

Grammar review summary

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

The document has 5 grammar and style issues, primarily related to capitalization, word choice, and grammatical phrasing for clarity.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

Grammar review summary

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

The document is well-structured and generally well-written. Minor grammatical and typographical improvements include correcting capitalization in a heading and button labels, hyphenating a compound adjective, and refining phrasing for clarity and idiomatic correctness.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

Grammar review summary

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

The document has minor grammatical and stylistic inconsistencies, including capitalization, word choice, and apostrophe usage. There is also a possessive pronoun error. Addressing these will improve the overall clarity and professionalism of the technical documentation.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

Grammar review summary

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

The document is well-written with only a few minor issues related to capitalization consistency for button labels and a slight rephrasing for clarity. The use of Markdown and code blocks is correctly handled.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

Grammar review summary

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

The document is well-written and clear. Only minor stylistic improvements were identified regarding the use of an informal abbreviation.


Was this feedback useful?

  • Yes
  • No

@mariana-caetano mariana-caetano changed the title [FastStore UI] Testing code example [FastStore UI] Fixing Button component code examples Aug 15, 2025
@mariana-caetano mariana-caetano changed the title [FastStore UI] Fixing Button component code examples [FastStore UI] Fixing 'Button' component code examples Aug 15, 2025
Copy link
Contributor

Grammar review summary

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

The document had a few minor issues related to preposition usage and the pluralization of 'do'. The corrections improve clarity and adhere to standard technical writing conventions.


Was this feedback useful?

  • Yes
  • No

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Contributor

github-actions bot commented Aug 25, 2025

Grammar review summary

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

The document has minor inconsistencies in capitalization of component names and button variants. Specific button labels could also benefit from quotation marks for clarity.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

github-actions bot commented Aug 25, 2025

Grammar review summary

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

The document is well-written with only one minor suggestion for improved conciseness in a sentence.


Was this feedback useful?

  • Yes
  • No

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Contributor

github-actions bot commented Aug 25, 2025

Grammar review summary

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

The document is well-structured and largely free of errors. The primary issues identified were the use of the informal abbreviation "w/" in button labels, which has been corrected to "with" for improved formality and clarity in technical documentation.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

Grammar review summary

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

The document is well-written with only a minor grammatical correction needed for the heading 'Do's'.


Was this feedback useful?

  • Yes
  • No

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Contributor

Grammar review summary

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

The document has a few minor issues related to formality and clarity in phrasing, such as the use of "and/or" and informal language like "look clickable". Additionally, consistent quoting for button labels and clearer phrasing for combined terms like "checkout/cart" would improve readability.


Was this feedback useful?

  • Yes
  • No

@mariana-caetano mariana-caetano mentioned this pull request Aug 25, 2025
4 tasks
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Contributor

Grammar review summary

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

The document is well-written with only minor hyphenation issues in compound adjectives. Specifically, 'finger-friendly' and 'icon-only' should be hyphenated for improved readability and grammatical correctness.


Was this feedback useful?

  • Yes
  • No

@mariana-caetano mariana-caetano changed the title [FastStore UI] Fixing 'Button' component code examples [FastStore UI] Fix 'Button' component code examples Aug 25, 2025
@mariana-caetano mariana-caetano merged commit 1a98f1a into main Aug 29, 2025
8 of 9 checks passed
@mariana-caetano mariana-caetano deleted the testing-button branch August 29, 2025 12:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants