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

github-actions bot commented Sep 17, 2025

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/molecules/product-card.mdx

The document contains several grammatical errors, including subject-verb agreement, awkward phrasing, and redundant words. There are also spelling mistakes ('Desing' instead of 'Design') and a typographic error with an extraneous code block closing tag. Additionally, some prepositions and compound adjectives have been corrected for clarity and conciseness.


Was this feedback useful?

  • Yes
  • No

@mariana-caetano mariana-caetano marked this pull request as draft September 17, 2025 21:59
Copy link
Contributor

Frontmatter errors in docs/faststore/components/molecules/product-card.mdx:

  • Does not start with frontmatter block ('---').

Copy link
Contributor

Grammar review summary

Review for docs/faststore/components/molecules/product-card.mdx

The document had several grammar and spelling issues, including subject-verb agreement, missing spaces, hyphenation, and word choice. These corrections enhance the clarity, formality, and overall professionalism of the technical documentation.


Was this feedback useful?

  • Yes
  • No

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 🐶
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:

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 🐶
In a heading, 'Buy Button' is typically written as two words for better readability, even if the corresponding prop is buyButton.

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 🐶
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" },

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 🐶
Corrected the spelling error from 'Desing' to 'Design'.

return useMemo(() => formatter(price), [formatter, price]);

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 🐶
Corrected the spelling error from 'Desing' to 'Design'.

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 🐶
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.

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 🐶
Changed 'on the store' to 'within the store' for more natural and idiomatic phrasing in this context.

Copy link
Contributor

Frontmatter errors in docs/faststore/components/molecules/product-card.mdx:

  • Does not start with frontmatter block ('---').

Copy link
Contributor

Grammar review summary

Review for docs/faststore/components/molecules/product-card.mdx

The document had several grammar and spelling issues, including subject-verb agreement, missing spaces, awkward phrasing, incorrect possessive apostrophes, and misspellings. Compound adjectives were also not consistently hyphenated, and some prepositions were used incorrectly. These corrections aim to improve the overall clarity and grammatical correctness of the technical documentation.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

Frontmatter errors in docs/faststore/components/molecules/product-card.mdx:

  • Does not start with frontmatter block ('---').

Copy link
Contributor

Grammar review summary

Review for docs/faststore/components/molecules/product-card.mdx

The document contained several grammatical and spelling errors, including subject-verb agreement, a missing space, vague phrasing, a misspelling of 'Design', and less idiomatic prepositions. Corrections have been provided for clarity and correctness.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

Frontmatter errors in docs/faststore/components/molecules/product-card.mdx:

  • Does not start with frontmatter block ('---').

Copy link
Contributor

Grammar review summary

Review for docs/faststore/components/molecules/product-card.mdx

The review identified several grammar, spelling, and stylistic improvements, including pronoun agreement, preposition usage, spelling corrections, and rephrasing for clarity and conciseness in technical documentation.


Was this feedback useful?

  • Yes
  • No

@github-actions github-actions bot force-pushed the main branch 2 times, most recently from 44809f5 to 9e4dab3 Compare September 30, 2025 14:50
Copy link
Contributor

github-actions bot commented Oct 1, 2025

Frontmatter errors in docs/faststore/components/molecules/product-card.mdx:

  • Does not start with frontmatter block ('---').

Copy link
Contributor

github-actions bot commented Oct 1, 2025

Documentation feedback for CHANGELOG.md

General Feedback

The provided document appears to be a changelog file for the dev-portal-content repository, automatically generated using standard-version. While it's well-structured and follows conventional commit guidelines, it doesn't align with the requirements for a Release Note as defined in the provided rules. Specifically, it lacks the necessary frontmatter (title, slug, type, excerpt, createdAt, etc.) and a structured body explaining the changes, their purpose, and user actions.

Actionable Feedback

  1. Missing Frontmatter: The document is missing the required frontmatter. Add a frontmatter section at the beginning of the document, including title, slug, type, excerpt, and createdAt.
  2. Incorrect Title Format: The title should follow the format <Product/Feature name>: <Summary>.
  3. Missing Slug: The slug should be in the format YYYY-MM-DD-title.
  4. Missing Type: The type field should indicate the category of the release (e.g., added, fixed, improved).
  5. Missing Excerpt: Add a brief, high-level summary of the release in the excerpt field.
  6. Missing CreatedAt: Include the date and time of the release note creation in ISO 8601 format.
  7. Unstructured Body: The changelog format doesn't provide explanations of changes, their purpose, or required user actions. Convert the relevant changelog entries into a structured body with sections like "What has changed?", "Why did we make this change?", and "What needs to be done?".
  8. Content Focus: The changelog includes many commits that are too granular for a release note (e.g., typo fixes, minor documentation updates). Focus on significant changes that impact users.
  9. Multiple Release Notes: The changelog contains numerous releases. Create separate release notes for each significant change, or group related changes into a single release note.

Suggested Revision

Here'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?

  • Yes
  • No

Copy link
Contributor

github-actions bot commented Oct 1, 2025

Documentation feedback for docs/faststore/docs/security/enabling-refresh-token.mdx

Okay, I've reviewed the Guide and have identified some areas for improvement based on the provided rules. Here's my feedback:

General Feedback

The 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

  1. Title: The title is good, but can be more concise.
  2. Before you begin: The content inside <Steps> is not necessary, since it is only two steps.
  3. Instructions: The steps are missing imperative verbs.
  4. Tone and Voice: Ensure the tone is direct and uses active voice.

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?

  • Yes
  • No

Copy link
Contributor

github-actions bot commented Oct 1, 2025

Grammar review summary

Review for docs/faststore/components/molecules/product-card.mdx

The document is generally well-written but contains several minor grammatical errors, typos, and awkward phrasings. Corrections focus on improving subject-verb agreement, preposition usage, conciseness, and spelling for enhanced clarity and professionalism in technical documentation.


Was this feedback useful?

  • Yes
  • No

@mariana-caetano mariana-caetano marked this pull request as ready for review October 1, 2025 20:08
Copy link
Contributor

github-actions bot commented Oct 1, 2025

Frontmatter errors in docs/faststore/components/molecules/product-card.mdx:

  • Does not start with frontmatter block ('---').

Copy link
Contributor

github-actions bot commented Oct 1, 2025

Grammar review summary

Review for docs/faststore/components/molecules/product-card.mdx

The document contains several grammatical and typographical errors, including issues with pronoun agreement, missing spaces, awkward phrasing, a redundant Markdown element, incorrect prepositions, and spelling mistakes. Addressing these will improve clarity and professionalism.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

github-actions bot commented Oct 1, 2025

Frontmatter errors in docs/faststore/components/molecules/product-card.mdx:

  • Does not start with frontmatter block ('---').

Copy link
Contributor

github-actions bot commented Oct 1, 2025

Grammar review summary

Review for docs/faststore/components/molecules/product-card.mdx

The document contains several minor grammatical and spelling errors, including subject-verb agreement issues, missing spaces, redundant words, and incorrect spelling of 'Design'. There was also an extraneous code block closing tag. Corrections have been provided to improve clarity, conciseness, and overall grammatical correctness.


Was this feedback useful?

  • Yes
  • No

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.

2 participants