Skip to content

update: improve search behavior guide#688

Open
julia-rabello wants to merge 2 commits into
mainfrom
update/improve-search-behavior-guide
Open

update: improve search behavior guide#688
julia-rabello wants to merge 2 commits into
mainfrom
update/improve-search-behavior-guide

Conversation

@julia-rabello
Copy link
Copy Markdown
Contributor

Summary

Provide a concise description of the change introduced by this PR.
Example: “Updates the Checkout overview to include new webhook behavior.”


Type of change

  • New content — Adds new documentation.
  • Content update — Improves existing documentation (clarity, structure, examples, accuracy).
  • Bug fix — Fixes markdown issues.
  • Editorial fix — Spelling, grammar, or minor copy edits that don’t change meaning.
  • Content removal — Deletes deprecated or obsolete content.

Checklist

  • The content follows the VTEX Style Guide.
  • Markdown renders correctly (headings, lists, tables, callouts).
  • Links, images, code blocks, and examples are valid.
  • Terminology, product names, and API references are consistent.
  • Frontmatter (title, description, tags, slug) is correct
  • Files follow the expected folder structure and naming conventions.

AI review instructions

This repository supports automated AI reviews for Markdown files in the docs/pt folder.

To run reviews on this PR, add at least one of the following labels:

  • AI style review: evaluates tone and adherence to VTEX style guidelines.
  • AI grammar review: identifies grammar and spelling issues.

Once at least one label is added, the review(s) will run automatically.

After the review is completed, the corresponding label will be removed and the label AI reviewed will be added to the PR.

Note

To rerun a review, remove and add the desired label again.

@github-actions
Copy link
Copy Markdown
Contributor

🧭 Navigation Generation Report

❌ Validation Status: FAILED

Parse errors: files could not be processed • Duplicate conflicts: 7 slug conflicts found

📝 Auto-commit: Navigation changes committed by workflow (commit d147d7d)

📊 Generation Details (click to expand)
Commit Date Duration
de395d3d3243259f600a25cc74d7171519a41a41 2026-04-22 14:25:41 -0300 9s
Metric Value Output Details
Files processed 12290 Path public/navigation.json
Files skipped Size 3.1M
Categories 394 SHA256 7551e4f750b787e8f02870e15f1e1d5d3297a9f8031054a6a2c7cd001b5d757a
Documents 4083 Duplicate conflicts 7
🔗 Duplicate Slug Conflicts (7 conflicts)
  • Duplicate slug '2020-mayo' found 2 times in section 'announcements' (es): category:'Mayo' at '2020 > Mayo' [en:'May', en-slug:'2020-may'], category:'Mayo' at '2020 > Mayo' [en-slug:'mayo']
  • Duplicate slug '2020-maio' found 2 times in section 'announcements' (pt): category:'Maio' at '2020 > Maio' [en:'May', en-slug:'2020-may'], category:'Maio' at '2020 > Maio' [en:'Mayo', en-slug:'mayo']
  • Duplicate slug 'integracion-de-lengow' found 2 times in section 'tracks' (es): category:'Integración de Lengow' at 'Marketplace > Integración de Lengow' [en:'Lengow integration', en-slug:'lengow-integration'], category:'Integración de Lengow' at 'Marketplace > Integración de Lengow'
  • Duplicate slug 'inventory-subcategory' found 2 times in section 'tutorials' (en): category:'Inventory' at 'Integrations > Inventory', category:'Inventory' at 'Shipping > Inventory'
  • Duplicate slug 'feedback-del-vendedor-subcategoria' found 2 times in section 'tutorials' (es): category:'Feedback del vendedor' at 'Indeva by VTEX > Feedback del vendedor' [en-slug:'feedback-del-vendedor'], category:'Feedback del vendedor' at 'Indeva by VTEX > Feedback del vendedor' [en:'Seller feedback', en-slug:'seller-feedback-subcategory']
  • Duplicate slug 'configurações-vtex-cx-platform-subcategoria' found 2 times in section 'tutorials' (pt): category:'Configurações VTEX CX Platform' at 'VTEX CX Platform > Configurações VTEX CX Platform' [en-slug:'configuracoes-vtex-cx-platform'], category:'Configurações VTEX CX Platform' at 'VTEX CX Platform > Configurações VTEX CX Platform' [en:'VTEX CX Platform Settings', en-slug:'vtex-cx-platform-settings-subcategory']
  • Duplicate slug 'otro' found 2 times in section 'known-issues' (es): category:'Otro' at 'Otro' [en:'Other', en-slug:'other'], category:'Otros' at 'Otros' [en:'Others', en-slug:'others']

📋 Generation Log: - Full log: Download navgen.log


Generated by nav-generation workflow

Quando o cliente abre um link da loja no navegador, a busca por ID costuma montar o endereço no caminho (path), com `map=ft`. Nesse padrão não entram os parâmetros de string de consulta `query` ou `q`.

* **Um item:** `[endereço da loja]/[tipo do id]:[id_1]?map=ft`
* **Vários itens (mesmo tipo de ID):** `[endereço da loja]/[tipo do id]:[id_1];[id_2];[id_3]?map=ft`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Senti falta de exemplos aqui. Não entendi o que é [tipo do id], por exemplo.

Separe os valores com ponto e vírgula `;` e escreva o tipo da ID uma vez só, por exemplo: `?query=product:98765;98743` (equivale a `?query=product.id:98765;98743`) ou `?query=sku.id:100;200`.

Para buscar a partir da URL da sua loja, adicione parâmetros de busca (*query*) no final da URL da loja, respeitando uma das estruturas a seguir:
Os possíveis valores para o tipo de ID são `product.id`, `sku.id`, `sku.ean`, `sku.reference`, `product.link` ou `id` (ProductID, ProductRefID, SKUID, SKURefID e EAN). Todos os IDs de uma mesma busca devem ser do mesmo tipo.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Isso vale também para storefront? Aqui parece que é só pra API.

* **Um item:** `[endereço da loja]/[tipo do id]:[id_1]?map=ft`
* **Vários itens (mesmo tipo de ID):** `[endereço da loja]/[tipo do id]:[id_1];[id_2];[id_3]?map=ft`

### Busca por ID na API do Intelligent Search
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Não conheço o público e casos de uso desse produto. Mas me ocorre que essa seção ficou um pouco técnica demais para o Help Center.

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