Skip to content

Conversation

barbara-celi
Copy link
Contributor

@barbara-celi barbara-celi commented Aug 6, 2025

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)

EDU-15731

@barbara-celi barbara-celi self-assigned this Aug 6, 2025
Copy link
Contributor

github-actions bot commented Aug 6, 2025

Navigation Preview Link

No changes detected in the navigation.json file

Copy link
Contributor

github-actions bot commented Aug 6, 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

github-actions bot commented Aug 6, 2025

Grammar review summary

Review for docs/faststore/components/features/delivery-promise.mdx

The review identified 26 grammar, spelling, and typographic issues. Key corrections include expanding contractions for a more formal tone, rephrasing for clarity and conciseness, ensuring correct spacing for units, and standardizing apostrophe usage. The document's overall readability and professionalism have been improved.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

github-actions bot commented Aug 7, 2025

Grammar review summary

Review for docs/faststore/components/features/delivery-promise.mdx

The document is generally well-written with only a few minor hyphenation and verb/noun usage issues. The identified issues primarily involve compound words that should be hyphenated when functioning as adjectives or verbs, and the correct two-word verb form of 'log in'.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

github-actions bot commented Aug 7, 2025

Grammar review summary

Review for docs/faststore/components/features/delivery-promise.mdx

The document is well-written with only a few minor grammatical and typographic adjustments needed for improved formality and adherence to style conventions.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

@lariciamota lariciamota left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi! I've commented an issue I've found (we don't have global filter by shipping method) that affects some sections changed in this PR. Another suggestion I'd make is to use screenshots from the faststore's figma instead of SF's, what do you think?


## Filter options

With Delivery Promise, shoppers can filter available products by using a [global filter](#global-filter), which affects all navigation, or directly on a [Product List Page (PLP) or search page](#plp-or-search-page-filters), affecting only the current page they're navigating. In both scenarios, they can filter by shipping method or pickup points.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: add something after the ", or" because it was confusing for me -- I thought it was talking about the global filter in the PLP.

Something like: , or by filtering directly on a(...) or , or a local filter directly on a(...)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: the last phrase is wrong In both scenarios, they can filter by shipping method or pickup points., global filter currently is only to filter by pickup point, and the local filter in PLP is by shipping method (delivery, pickup nearby, pickup at, pickup anywhere)

Copy link
Contributor

github-actions bot commented Aug 8, 2025

Grammar review summary

Review for docs/faststore/components/features/delivery-promise.mdx

The document is well-written with only a few minor grammatical and typographic issues. The main corrections involve adding spaces between numerical values and unit symbols (e.g., '50 km' instead of '50km') and refining phrasing for clarity and formality in technical documentation.


Was this feedback useful?

  • Yes
  • No


This solution continuously updates product availability throughout the buying journey by responding to changes in catalog, pricing, inventory, or shipping settings. These updates are then sent to [Checkout](https://developers.vtex.com/docs/guides/checkout-overview) and [Intelligent Search](https://help.vtex.com/tracks/vtex-intelligent-search), ensuring customers see up-to-date options based on their region.

This feature introduces new hooks as part of the regionalization and location workflow:
## Hooks
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As seções Hooks, Filter options e Default settings são partes mais conceituais da feature ou fazem parte dos passos de configuração?

Fiquei em dúvida porque parece que os passos práticos só aparecem em "Before you begin" e depois. Como essas seções são mais explicativas, vale deixar claro que elas são conceituais ou algo do tipo. Apesar dessas seções serem importantes para contextualizar, não fica claro que são seções concetuais e a pessoa pode esperar passos, mas isso acontece só depois.

Se for o caso dessas três seções acho que vale rever a estrutura do guia. Por exemplo, mudar a estrutura para algo como:

Ter conceitos antes da configuração:

1. Intro
2. Delivery Promise concepts
    - Hooks
    - Filter options
    - Default settings
 3. Before you begin
 4. Instructions

ou

Ter a configuração /implementação antes e a referência para conceitos depois

1. Intro
2. Before you begin
3. Instructions
4. Delivery Promise concepts
    - Hooks
    - Filter options
    - Default settings

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

São mais conceituais mesmo. Até pensei em criar uma doc separada pra isso, mas acho que essas informações ficariam meio perdidas sozinhas.

- `useRegion`: Accesses or updates the user's region information, such as postal code or location.
- `useRegionModal`: Handles modal display logic for region selection, especially when the location input is required.
- `useGeoLocation`: Uses the browser’s geolocation API or other client-side methods to attempt to auto-detect the user's location.
This feature introduces the following hooks as part of the regionalization and location workflow:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Com esses novos hooks é possível customizar seções ou componentes?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pelo o que entendi, não. Vou confirmar.


You only need to [add a new section](#step-3-adding-region-popover-section), the `Region Popover`.

### Step 3 - Adding `Region Popover` section

`RegionPopover` is a section that manages user location inputs. It's used when location data is missing or the store's default postal code is applied. Available in [`@faststore/core`](https://developers.vtex.com/docs/guides/faststore/project-structure-overview#packagejson), `RegionPopover` uses the [`Popover`](https://developers.vtex.com/docs/guides/faststore/molecules-popover) component as its UI base.
`RegionPopover` is a section that manages user location inputs. It's used when location data is missing, or the store's default postal code is applied. Available in [`@faststore/core`](https://developers.vtex.com/docs/guides/faststore/project-structure-overview#packagejson), `RegionPopover` uses the [`Popover`](https://developers.vtex.com/docs/guides/faststore/molecules-popover) component as its UI base.

![regionpopover](https://vtexhelp.vtexassets.com/assets/docs/src/regionpopover___dedb0aad756657e71d4c8d40cb2ef5e7.png)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Esse código precisa ser implementado em algum lugar? Fiquei com dúvida sobre por que ele aparece aqui, antes dos passos. Vale adicionar uma breve explicação no dropdown explicando sua finalidade.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Esse código entrou aí porque não teve como documentar esse componente em outro lugar da mesma maneira que documentamos os que estão no faststore/ui. Isso porque o RegionPopover está somente no core, e não foi possível exportá-lo no vtexdocs/devportal. A saída, então, foi documentá-lo diretamente na doc do Delivery Promise, inserindo ali também o código.

1. **User-provided location:** If the user provided their location, such as postal code, this information is used.
2. **Logged-in user’s address:** If the user hasn’t provided a postal code, we attempt to identify the location using the logged-in user's address.
3. **Default postal code:** If the user hasn't provided a location, isn’t logged in, or has no saved address, we check if the merchant has configured a default postal code for all buyers. Learn to do so in [Defining a default postal code](#step-4-optional-defining-a-default-postal-code).
1. **Logged in user's address:** If the user is logged in and has a saved address, this information is used.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

O título desse Step 4 com as novas diretrizes que estamos revisando ficará: "Step 4 - (Optional) Defining a default postal code"

Co-authored-by: Mariana Caetano Pereira <[email protected]>
Copy link
Contributor

Grammar review summary

Review for docs/faststore/components/features/delivery-promise.mdx

The document is generally well-written. The identified issues are minor and relate to consistency in terminology, precision in technical phrasing, and clarity in describing UI behavior.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

Grammar review summary

Review for docs/faststore/components/features/delivery-promise.mdx

The document is well-written with only one minor suggestion for improved clarity regarding versioning terminology. The grammar, spelling, and typography are generally excellent.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

Grammar review summary

Review for docs/faststore/components/features/implementation.mdx

The review identified several opportunities to enhance clarity, conciseness, and consistency in the technical documentation. Corrections primarily focused on refining technical terminology, improving sentence structure, and ensuring consistent phrasing for better readability.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

Grammar review summary

Review for docs/faststore/components/features/delivery-promise/implementation.mdx

The document is generally well-written and clear. Minor improvements can be made by using more concise language, avoiding contractions, and refining terminology for a more formal and precise technical tone.


Was this feedback useful?

  • Yes
  • No

Copy link
Contributor

Grammar review summary

Review for docs/faststore/components/features/delivery-promise/implementation.mdx

The document is well-written with only a few minor grammatical and stylistic improvements identified for enhanced clarity and conciseness.


Was this feedback useful?

  • Yes
  • No

- `useRegion`: Accesses or updates the user's region information, such as postal code or location.
- `useRegionModal`: Handles modal display logic for region selection, especially when the location input is required.
- `useGeoLocation`: Uses the browser’s geolocation API or other client-side methods to attempt to auto-detect the user's location.
To understand how Delivery Promise operates, see the guide [Delivery Promise (Beta)](https://developers.vtex.com/docs/guides/faststore/features-delivery-promise-overview).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[link-check] reported by reviewdog 🐶
🚨 Found a broken link in a Markdown Link (Error 404):
https://developers.vtex.com/docs/guides/faststore/features-delivery-promise-overview

👉 Please review this link before merging your Pull Request.

Copy link
Contributor

Grammar review summary

Review for docs/faststore/components/features/delivery-promise/implementation.mdx

The document is well-written and clear. Only one minor suggestion was identified for improved clarity regarding version numbering.


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 🐶
Added "major version" for clarity and completeness when referring to a version number.

<summary>Accounts that want to migrate to the `5.x`</summary>

@barbara-celi barbara-celi merged commit 4a24b1a into main Aug 22, 2025
8 of 9 checks passed
@barbara-celi barbara-celi deleted the EDU-15731 branch August 22, 2025 15:12
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.

3 participants