-
Notifications
You must be signed in to change notification settings - Fork 98
EDU-16043: ProductCard review #2151 #2176
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Navigation Preview LinkNo changes detected in the navigation.json file |
Preview LinksOpen this URL to set up the portal with this branch changes. You can now access the edited pages with the following URLs:
|
Grammar review summaryReview for
|
Frontmatter errors in
|
Grammar review summaryReview for
|
There was a problem hiding this comment.
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 🐶
Corrected subject-verb agreement from 'They usually present' to 'It usually presents' because ProductCard
is singular. Added a missing space after the period between 'image' and 'The'.
The `ProductCard` displays summarized information about a product. It usually presents a call-to-action button, as well as the product's name, price, and image. The `ProductCard` is composed of the following components: |
There was a problem hiding this comment.
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 🐶
In a heading, 'Buy Button' is typically written as two words for better readability, even if the corresponding prop is buyButton
.
</ProductCardImage> |
There was a problem hiding this comment.
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 🐶
Changed 'on both' to 'to both' for more precise phrasing when referring to adding a prop. Added 'the' before 'outOfStock
prop' for better flow.
isVariantOf: { name: "Apple Mouse" }, |
There was a problem hiding this comment.
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 🐶
Corrected the spelling error from 'Desing' to 'Design'.
return useMemo(() => formatter(price), [formatter, price]); |
There was a problem hiding this comment.
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 🐶
Corrected the spelling error from 'Desing' to 'Design'.
<ProductCardContent |
There was a problem hiding this comment.
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 🐶
Improved clarity and conciseness by rephrasing 'all attributes also supported by' to 'the attributes of'. Hyphenated 'product card-related'. Changed 'Besides those attributes' to 'In addition to these attributes' for more formal and precise language.
offers: [ |
There was a problem hiding this comment.
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 🐶
Changed 'on the store' to 'within the store' for more natural and idiomatic phrasing in this context.
Frontmatter errors in
|
Grammar review summaryReview for
|
Frontmatter errors in
|
Grammar review summaryReview for
|
Frontmatter errors in
|
Grammar review summaryReview for
|
44809f5
to
9e4dab3
Compare
Frontmatter errors in
|
Documentation feedback for CHANGELOG.mdGeneral FeedbackThe provided document appears to be a changelog file for the Actionable Feedback
Suggested RevisionHere's an example of how a section of the changelog could be converted into a proper release note, focusing on the "add new delivery promise documentation" commit: ---
title: VTEX IO: Added Delivery Promise Documentation
slug: 2025-09-03-delivery-promise-documentation
type: added
excerpt: New documentation added to guide developers in implementing the Delivery Promise feature.
createdAt: 2025-09-03T10:00:00Z
---
# VTEX IO: Added Delivery Promise Documentation
## What has changed?
We've added new documentation to the VTEX Developer Portal that guides developers in implementing the Delivery Promise feature. This includes guides on the overview, components, implementation, and more.
## Why did we make this change?
The Delivery Promise feature is a powerful tool for improving the customer experience by providing accurate delivery estimates. This documentation aims to make it easier for developers to understand and implement this feature.
## What needs to be done?
To start using the Delivery Promise feature, refer to the new documentation in the VTEX Developer Portal. You can find the guides in the Delivery Promise section.
[Delivery Promise Documentation](link-to-delivery-promise-documentation) Was this feedback useful?
|
Documentation feedback for docs/faststore/docs/security/enabling-refresh-token.mdxOkay, I've reviewed the Guide and have identified some areas for improvement based on the provided rules. Here's my feedback: General FeedbackThe guide is generally well-structured and provides clear instructions. However, there are a few areas where the content can be improved to better align with the documentation guidelines, particularly regarding the use of imperative verbs, the tone, and the structure of the "Before you begin" section. Actionable Feedback
Suggested Revision---
title: "Enabling refresh token in FastStore"
excerpt: "Automatically refresh user sessions without re-logging in by enabling the refresh token flow in your FastStore project."
createdAt: "2025-08-15T14:00:00.000Z"
updatedAt: "2025-09-17T09:00:00.000Z"
---
[Refresh token](https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations) is a security mechanism that allows users to obtain a new, short-lived access token without requiring them to log in again.
The [FastStore SDK Session](https://developers.vtex.com/docs/guides/faststore/sdk-overview#session) includes built-in support for the [refresh token](https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations) flow. It automatically manages token renewal, session management, and error handling.
As a FastStore user, you only need to enable the refresh token in your project configuration. The SDK will manage the process automatically, without requiring you to implement a custom flow.
In this guide, you'll learn how to enable the refresh token in a FastStore store.
> ℹ️ For details about how the refresh tokens work, check the [Refresh token flow for headless implementations guide](https://developers.vtex.com/docs/guides/refresh-token-flow-for-headless-implementations).
## Before you begin
Before enabling the refresh token, ensure you have:
1. **Updated your FastStore project:** Open your project in a code editor and run the following command in a terminal to update the FastStore packages to the latest version:
```bash
yarn upgrade -L --scope @faststore
```
2. **Requested refresh token activation:** Open a ticket with [VTEX Support](https://help.vtex.com/en/support) to request refresh token activation and an expiration time (1, 7, or 30 days). Include the account name(s) in your request to enable the feature. Without this activation, you won’t be able to enable the refresh token in your account.
## Instructions
1. **Open** your FastStore project in a code editor.
2. **Add** the `refreshToken` flag and set its value to `true` in the `experimental` section of the `discovery.config.js` file:
```js discovery.config.js
experimental: {
…
refreshToken: true
}
```
3. **Commit** and **push** your changes to the main branch to deploy the changes to production. Was this feedback useful?
|
Grammar review summaryReview for
|
Frontmatter errors in
|
Grammar review summaryReview for
|
Frontmatter errors in
|
Grammar review summaryReview for
|
Types of changes