From 1a8fe576cc0187948e2ef44f60627f01fb77e79a Mon Sep 17 00:00:00 2001 From: "George B. de Lima" <106821144+GeorgeLimaDev@users.noreply.github.com> Date: Wed, 30 Jul 2025 15:59:46 -0300 Subject: [PATCH 1/3] New translations reviews-and-ratings.mdx (English, United States) --- docs/localization/reviews-and-ratings.mdx.mdx | 119 ++++++++++++++++++ 1 file changed, 119 insertions(+) create mode 100644 docs/localization/reviews-and-ratings.mdx.mdx diff --git a/docs/localization/reviews-and-ratings.mdx.mdx b/docs/localization/reviews-and-ratings.mdx.mdx new file mode 100644 index 0000000000..eb74075dad --- /dev/null +++ b/docs/localization/reviews-and-ratings.mdx.mdx @@ -0,0 +1,119 @@ +--- +title: Reviews and Ratings +--- + +The Reviews and Ratings feature allows shoppers to view, rate, and provide feedback on products purchased in your store, enriching product details pages (PDPs) with user-generated content. + +This solution supports star ratings, review listing, filtering, and sorting options. Authenticated users can leave feedback directly on the product page. + +![reviews-and-ratings-fs](https://vtexhelp.vtexassets.com/assets/docs/src/reviews-and-ratings___25b285d318994bb3de9d447d90829dd0.png) + +## App behavior + +* **Authentication required:** Only logged-in customers can submit reviews. Anonymous reviews aren't supported. +* **Reviews management:** Customers can't view or manage their submitted reviews. +* **Automatic approval:** All reviews are automatically approved and published upon submission without prior moderation. Still, store administrators can remove individual reviews anytime using the Reviews and Ratings app through the VTEX Admin. + +## Before you begin + + + ### Install the Reviews and Ratings app + + 1. Open your terminal and log in to your account by running the command `vtex login {accountName}`. Replace the values inside the curly brackets based on your scenario. + 2. Run the `vtex list` command to view all VTEX apps installed in the current account and workspace. + 3. Check if the `Reviews and Ratings` app is installed. If so, proceed to the next (#updating-the-faststore-cli-package-version) step. + 4. If the Reviews and Ratings app isn't installed in your account, run the `vtex install vtex.reviews-and-ratings@3.x` command to install it. You should see this confirmation message: `info: Installed app vtex.reviews-and-ratings@3.x successfully`. + + ### Update the `@faststore/cli` package version + + Make sure your store uses the latest version of the [`faststore/cli`](https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli) package: + + 1. Open your FastStore codebase in the code editor of your choice. + 2. Open the terminal and run the `yarn add @faststore/cli@latest` command. + 3. Run `yarn dev` to sync the changes to your project. + + +## Instructions + +### Step 1 - Enabling `reviewsAndRatings` + +1. Open the `discovery.config.js` file in your project. +2. Set the `reviewsAndRatings` field to **true**. + +```javascript discovery.config.js +module.exports = { + ... + reviewsAndRatings: true, +} +``` + +> ℹ️ This feature is enabled by default. To disable it, open the [`discovery.config.js`](https://developers.vtex.com/docs/guides/faststore/project-structure-config-options) file and set the `reviewsAndRatings` field to **false**. + +### Step 2 - Syncing the FastStore project with Headless CMS + +Run the `faststore cms-sync` command to sync the `cms` folder of your FastStore project with the [Headless CMS](https://developers.vtex.com/docs/guides/faststore/headless-cms-overview). + +The expected response is the message `CMS synced successfully...`. The native components of the Reviews and Ratings feature will be updated automatically. + +### Step 3 - Adding the `ReviewsAndRatings` section + +The `ReviewsAndRatings` section displays customer feedback and product ratings. + +1. In the VTEX Admin, go to **Storefront > Headless CMS > Product Details Page**. +2. In the Sections tab, click `+` to open a modal with a list of section options. +3. Search for the **ReviewsAndRatings** section and click it to add. +4. Click `Save` to apply your changes. +5. Click `Publish` to open a dropdown list with the options `Add to Release`, to schedule the update, and `Publish now`, to publish immediately. Choose the most suitable option for your scenario. + +### Step 4 - [Optional] Customizing Reviews and Ratings + +To customize the component, see the [List of Native Sections and Overridable Components](https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections#reviews-and-ratings) to check which components can be overridden. + +## Components + +The **Reviews and Ratings** feature comprises modular, reusable native components. See below the key components of this solution: + + + + { + alert('This could trigger the RegionModal.') + }} + /> + + + + + + + + + + + + + + + + + + + + From 37c8497a66d2e81d6d63a1a3042a13df1d284486 Mon Sep 17 00:00:00 2001 From: GeorgeLimaDev Date: Wed, 30 Jul 2025 16:01:28 -0300 Subject: [PATCH 2/3] Apply localization review --- docs/localization/reviews-and-ratings.mdx | 126 +++++++++------------- 1 file changed, 49 insertions(+), 77 deletions(-) diff --git a/docs/localization/reviews-and-ratings.mdx b/docs/localization/reviews-and-ratings.mdx index dbf7e66a44..eb74075dad 100644 --- a/docs/localization/reviews-and-ratings.mdx +++ b/docs/localization/reviews-and-ratings.mdx @@ -1,8 +1,8 @@ --- title: Reviews and Ratings ---- +--- -The Reviews and Ratings feature allows shoppers to view, rate, and provide feedback on products purchased in your store, enriching product detail pages (PDPs) with user-generated content. +The Reviews and Ratings feature allows shoppers to view, rate, and provide feedback on products purchased in your store, enriching product details pages (PDPs) with user-generated content. This solution supports star ratings, review listing, filtering, and sorting options. Authenticated users can leave feedback directly on the product page. @@ -10,29 +10,27 @@ This solution supports star ratings, review listing, filtering, and sorting opti ## App behavior -* **Authentication required:** Only logged-in customers can submit reviews. Anonymous reviews aren’t supported. -* **Reviews management:** Customers cannot view or manage a list of their submitted reviews. -* **Automatic approval:** All reviews are automatically approved and published upon submission without prior moderation. Still, store administrators can remove individual reviews anytime using the Reviews and Ratings app through VTEX Admin. +* **Authentication required:** Only logged-in customers can submit reviews. Anonymous reviews aren't supported. +* **Reviews management:** Customers can't view or manage their submitted reviews. +* **Automatic approval:** All reviews are automatically approved and published upon submission without prior moderation. Still, store administrators can remove individual reviews anytime using the Reviews and Ratings app through the VTEX Admin. ## Before you begin + ### Install the Reviews and Ratings app -### Install the Reviews and Ratings app - -1. Open your terminal and log in to your account by running the command `vtex login {accountName}`. Replace the values between the curly brackets according to your scenario. -2. Run the `vtex list` command to list all VTEX apps installed in the active account and workspace. -3. Check if you have the `Reviews and Ratings` app. If you have, go to the following (#updating-the-faststore-cli-package-version) step. -4. If you don’t have the app, run the `vtex install vtex.reviews-and-ratings@3.x` command to install the Reviews and Ratings app in your account. It’s expected that you receive the message: `info: Installed app vtex.reviews-and-ratings@3.x successfully`. + 1. Open your terminal and log in to your account by running the command `vtex login {accountName}`. Replace the values inside the curly brackets based on your scenario. + 2. Run the `vtex list` command to view all VTEX apps installed in the current account and workspace. + 3. Check if the `Reviews and Ratings` app is installed. If so, proceed to the next (#updating-the-faststore-cli-package-version) step. + 4. If the Reviews and Ratings app isn't installed in your account, run the `vtex install vtex.reviews-and-ratings@3.x` command to install it. You should see this confirmation message: `info: Installed app vtex.reviews-and-ratings@3.x successfully`. -### Update the `@faststore/cli` package version + ### Update the `@faststore/cli` package version -Make sure your store uses the latest version of the [`faststore/cli`](https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli) package: - -1. Open your FastStore codebase in the code editor of your choice. -2. Open the terminal and run the `yarn add @faststore/cli@latest` command. -3. Run `yarn dev` to sync the changes to your project + Make sure your store uses the latest version of the [`faststore/cli`](https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli) package: + 1. Open your FastStore codebase in the code editor of your choice. + 2. Open the terminal and run the `yarn add @faststore/cli@latest` command. + 3. Run `yarn dev` to sync the changes to your project. ## Instructions @@ -42,105 +40,79 @@ Make sure your store uses the latest version of the [`faststore/cli`](https://de 1. Open the `discovery.config.js` file in your project. 2. Set the `reviewsAndRatings` field to **true**. - ```javascript discovery.config.js - module.exports = { - ... - reviewsAndRatings: true, - } - ``` +```javascript discovery.config.js +module.exports = { + ... + reviewsAndRatings: true, +} +``` ->ℹ️ This feature is enabled by default. To disable, go to the [`discovery.config.js`](https://developers.vtex.com/docs/guides/faststore/project-structure-config-options) file and set the `reviewsAndRatings` field to **false**. +> ℹ️ This feature is enabled by default. To disable it, open the [`discovery.config.js`](https://developers.vtex.com/docs/guides/faststore/project-structure-config-options) file and set the `reviewsAndRatings` field to **false**. -### Step 2 - Syncing FastStore project with Headless CMS +### Step 2 - Syncing the FastStore project with Headless CMS Run the `faststore cms-sync` command to sync the `cms` folder of your FastStore project with the [Headless CMS](https://developers.vtex.com/docs/guides/faststore/headless-cms-overview). -The expected response is that you receive the message `CMS synced successfully...`. The native components of the Reviews and Ratings feature will be automatically updated. +The expected response is the message `CMS synced successfully...`. The native components of the Reviews and Ratings feature will be updated automatically. -### Step 3 - Adding `ReviewsAndRatings` section +### Step 3 - Adding the `ReviewsAndRatings` section The `ReviewsAndRatings` section displays customer feedback and product ratings. -1. Access your VTEX Admin and go to **Storefront > Headless CMS > Product Details Page**. +1. In the VTEX Admin, go to **Storefront > Headless CMS > Product Details Page**. 2. In the Sections tab, click `+` to open a modal with a list of section options. -3. Search for the **ReviewsAndRatings** section and click on it to add. -4. Click `Save` to save your changes. +3. Search for the **ReviewsAndRatings** section and click it to add. +4. Click `Save` to apply your changes. 5. Click `Publish` to open a dropdown list with the options `Add to Release`, to schedule the update, and `Publish now`, to publish immediately. Choose the most suitable option for your scenario. ### Step 4 - [Optional] Customizing Reviews and Ratings -To customize your component, see the [List of Native Sections and Overridable Components](https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections#reviews-and-ratings) to check the components that can be overridden. +To customize the component, see the [List of Native Sections and Overridable Components](https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections#reviews-and-ratings) to check which components can be overridden. ## Components -**Reviews and Ratings** feature comprises modular, reusable native components. See below the key components that compose this solution: +The **Reviews and Ratings** feature comprises modular, reusable native components. See below the key components of this solution: - + { - alert('This could trigger the RegionModal.') + alert('This could trigger the RegionModal.') }} /> - + + - - + + + - + + - + + From ad020e09ec8029bb8a85f794e1c765a0df54a389 Mon Sep 17 00:00:00 2001 From: GeorgeLimaDev Date: Wed, 30 Jul 2025 16:03:52 -0300 Subject: [PATCH 3/3] Apply localization review --- docs/localization/reviews-and-ratings.mdx | 31 ++--- docs/localization/reviews-and-ratings.mdx.mdx | 119 ------------------ 2 files changed, 16 insertions(+), 134 deletions(-) delete mode 100644 docs/localization/reviews-and-ratings.mdx.mdx diff --git a/docs/localization/reviews-and-ratings.mdx b/docs/localization/reviews-and-ratings.mdx index eb74075dad..6e4adcf48e 100644 --- a/docs/localization/reviews-and-ratings.mdx +++ b/docs/localization/reviews-and-ratings.mdx @@ -17,6 +17,7 @@ This solution supports star ratings, review listing, filtering, and sorting opti ## Before you begin + ### Install the Reviews and Ratings app 1. Open your terminal and log in to your account by running the command `vtex login {accountName}`. Replace the values inside the curly brackets based on your scenario. @@ -40,12 +41,12 @@ This solution supports star ratings, review listing, filtering, and sorting opti 1. Open the `discovery.config.js` file in your project. 2. Set the `reviewsAndRatings` field to **true**. -```javascript discovery.config.js -module.exports = { - ... - reviewsAndRatings: true, -} -``` + ```javascript discovery.config.js + module.exports = { + ... + reviewsAndRatings: true, + } + ``` > ℹ️ This feature is enabled by default. To disable it, open the [`discovery.config.js`](https://developers.vtex.com/docs/guides/faststore/project-structure-config-options) file and set the `reviewsAndRatings` field to **false**. @@ -78,7 +79,7 @@ The **Reviews and Ratings** feature comprises modular, reusable native component { - alert('This could trigger the RegionModal.') + alert('This could trigger the RegionModal.') }} /> @@ -103,16 +104,16 @@ The **Reviews and Ratings** feature comprises modular, reusable native component ratingValue={4.2} reviewCount={18} distribution={{ - starsOne: 5, - starsTwo: 3, - starsThree: 2, - starsFour: 4, - starsFive: 4, + starsOne: 5, + starsTwo: 3, + starsThree: 2, + starsFour: 4, + starsFive: 4, }} textLabels={{ - ratingCounter: { - multipleReviewsText: 'Reviews', - }, + ratingCounter: { + multipleReviewsText: 'Reviews', + }, }} /> diff --git a/docs/localization/reviews-and-ratings.mdx.mdx b/docs/localization/reviews-and-ratings.mdx.mdx deleted file mode 100644 index eb74075dad..0000000000 --- a/docs/localization/reviews-and-ratings.mdx.mdx +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: Reviews and Ratings ---- - -The Reviews and Ratings feature allows shoppers to view, rate, and provide feedback on products purchased in your store, enriching product details pages (PDPs) with user-generated content. - -This solution supports star ratings, review listing, filtering, and sorting options. Authenticated users can leave feedback directly on the product page. - -![reviews-and-ratings-fs](https://vtexhelp.vtexassets.com/assets/docs/src/reviews-and-ratings___25b285d318994bb3de9d447d90829dd0.png) - -## App behavior - -* **Authentication required:** Only logged-in customers can submit reviews. Anonymous reviews aren't supported. -* **Reviews management:** Customers can't view or manage their submitted reviews. -* **Automatic approval:** All reviews are automatically approved and published upon submission without prior moderation. Still, store administrators can remove individual reviews anytime using the Reviews and Ratings app through the VTEX Admin. - -## Before you begin - - - ### Install the Reviews and Ratings app - - 1. Open your terminal and log in to your account by running the command `vtex login {accountName}`. Replace the values inside the curly brackets based on your scenario. - 2. Run the `vtex list` command to view all VTEX apps installed in the current account and workspace. - 3. Check if the `Reviews and Ratings` app is installed. If so, proceed to the next (#updating-the-faststore-cli-package-version) step. - 4. If the Reviews and Ratings app isn't installed in your account, run the `vtex install vtex.reviews-and-ratings@3.x` command to install it. You should see this confirmation message: `info: Installed app vtex.reviews-and-ratings@3.x successfully`. - - ### Update the `@faststore/cli` package version - - Make sure your store uses the latest version of the [`faststore/cli`](https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli) package: - - 1. Open your FastStore codebase in the code editor of your choice. - 2. Open the terminal and run the `yarn add @faststore/cli@latest` command. - 3. Run `yarn dev` to sync the changes to your project. - - -## Instructions - -### Step 1 - Enabling `reviewsAndRatings` - -1. Open the `discovery.config.js` file in your project. -2. Set the `reviewsAndRatings` field to **true**. - -```javascript discovery.config.js -module.exports = { - ... - reviewsAndRatings: true, -} -``` - -> ℹ️ This feature is enabled by default. To disable it, open the [`discovery.config.js`](https://developers.vtex.com/docs/guides/faststore/project-structure-config-options) file and set the `reviewsAndRatings` field to **false**. - -### Step 2 - Syncing the FastStore project with Headless CMS - -Run the `faststore cms-sync` command to sync the `cms` folder of your FastStore project with the [Headless CMS](https://developers.vtex.com/docs/guides/faststore/headless-cms-overview). - -The expected response is the message `CMS synced successfully...`. The native components of the Reviews and Ratings feature will be updated automatically. - -### Step 3 - Adding the `ReviewsAndRatings` section - -The `ReviewsAndRatings` section displays customer feedback and product ratings. - -1. In the VTEX Admin, go to **Storefront > Headless CMS > Product Details Page**. -2. In the Sections tab, click `+` to open a modal with a list of section options. -3. Search for the **ReviewsAndRatings** section and click it to add. -4. Click `Save` to apply your changes. -5. Click `Publish` to open a dropdown list with the options `Add to Release`, to schedule the update, and `Publish now`, to publish immediately. Choose the most suitable option for your scenario. - -### Step 4 - [Optional] Customizing Reviews and Ratings - -To customize the component, see the [List of Native Sections and Overridable Components](https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections#reviews-and-ratings) to check which components can be overridden. - -## Components - -The **Reviews and Ratings** feature comprises modular, reusable native components. See below the key components of this solution: - - - - { - alert('This could trigger the RegionModal.') - }} - /> - - - - - - - - - - - - - - - - - - - -