Skip to content

Commit

Permalink
docs: add prettier changes
Browse files Browse the repository at this point in the history
  • Loading branch information
@herrardo
herrardo committed Oct 26, 2023
1 parent c849f28 commit b27f562
Show file tree
Hide file tree
Showing 15 changed files with 63 additions and 58 deletions.
12 changes: 6 additions & 6 deletions ...ges/x-components/static-docs/build-search-ui/web-archetype-integration-guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -308,12 +308,12 @@ object allows your commerce store to communicate with Interface X. It suppo
functions to integrate Interface X in your website. You can access these functions inside the
`window.InterfaceX` object.

| Function | Parameters | Description |
| ------------------ | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `init` | [snippet configuration params](#snippet-configuration) - _Required_. Initialization options | [Initializes Interface X on demand](#initializing-interface-x-project-on-demand). |
| `search` | `query` - _Optional_. Query to open Interface X | Executes Interface X and triggers a search with the given query. |
| `close` | none | Closes Interface X search layer. |
| `setSnippetConfig` | [snippet configuration params](#snippet-configuration) - _Required_. Initialization options | Changes initialization options so that all components react to the changes, i.e. changing both search engine and language without reloading the page. |
| Function | Parameters | Description |
| ------------------ | ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `init` | [snippet configuration params](#snippet-configuration) - _Required_. Initialization options | [Initializes Interface X on demand](#initializing-interface-x-project-on-demand). |
| `search` | `query` - _Optional_. Query to open Interface X | Executes Interface X and triggers a search with the given query. |
| `close` | none | Closes Interface X search layer. |
| `setSnippetConfig` | [snippet configuration params](#snippet-configuration) - _Required_. Initialization options | Changes initialization options so that all components react to the changes, i.e. changing both search engine and language without reloading the page. |
| `addProductToCart` | `productId` - _Optional._ Id of the product added to cart | Sends tracking of the `AddToCart` event to the [Empathy Tagging microservice](/develop-empathy-platform/capture-interaction-signals/tagging-api-guide.md) for the product displayed on screen. This function is called from the product detail page (PDP) when the shopper clicks on the add-to-cart button. If the `productId` is not provided, the URL detects whether the shopper found the product via a search session or not. |

### Dynamic query results preview
Expand Down
3 changes: 1 addition & 2 deletions packages/x-components/static-docs/experience-search-and-discovery/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Design your search and discovery UI
meta_title: Search & discovery UI functional documentation
sidebar_title: Design search & discovery UI
redirect_from:
- /explore-empathy-platform/experience-search-and-discovery/
- /explore-empathy-platform/experience-search-and-discovery/
---

Search inevitably is key when people look for specific products in an online store. It's the door to
Expand All @@ -16,7 +16,6 @@ shoppers need a new dimension to **connect effortlessly** to the most relevant p

![Design search and discovery](~@assets/x/interface/experience-search-intro.svg)


## Interface X and Interface X for Apps, the solution

Interface X and Interface X for Apps are a collection of libraries that lets you create a
Expand Down
18 changes: 10 additions & 8 deletions packages/x-components/static-docs/experience-search-and-discovery/empathize.md
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
---
title: Design the Empathize UI experience
sidebar_title: Empathize UI
sidebar_title: Empathize UI
tags:
- predictive layer
- search box
redirect_from:
- /explore-empathy-platform/experience-search-and-discovery/empathize.html
- /explore-empathy-platform/experience-search-and-discovery/empathize
- /explore-empathy-platform/experience-search-and-discovery/empathize.html
- /explore-empathy-platform/experience-search-and-discovery/empathize
---

Empathize is a UI container, but not just any container. It’s the
**[predictive layer](/understand-empathy-platform/search-basics/predictive-layer.md)** for your search
experience that is usually displayed below the search box. Consider it the natural companion of the
**[search box](/onboard-empathy-platform/experience-search-and-discovery/search-box.md)**, featuring search suggestions and recommendations.
**[predictive layer](/understand-empathy-platform/search-basics/predictive-layer.md)** for your
search experience that is usually displayed below the search box. Consider it the natural companion
of the **[search box](/onboard-empathy-platform/experience-search-and-discovery/search-box.md)**,
featuring search suggestions and recommendations.

![Empathize](~@assets/x/interface/x-empathize.gif)

Expand All @@ -32,8 +33,9 @@ Thanks to the nature of Interface X Components, you can
you use within Empathize. For example, provide shoppers with search ideas and use Empathize to
display popular search terms and trending products. Anticipate your shoppers’ intent with recent
searches and query suggestions. Or give shoppers access to their
[complete search history](/onboard-empathy-platform/experience-search-and-discovery/my-history.md) and let them control tracking search data. There are lots
of handy possibilities that you might want to place close to the search box.
[complete search history](/onboard-empathy-platform/experience-search-and-discovery/my-history.md)
and let them control tracking search data. There are lots of handy possibilities that you might want
to place close to the search box.

**Combine Empathize with:**

Expand Down
4 changes: 2 additions & 2 deletions .../x-components/static-docs/experience-search-and-discovery/facets-and-filters.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ sidebar_title: Facets & Filters UI
tag:
- faceted
redirect_from:
- /explore-empathy-platform/experience-search-and-discovery/facets-and-filters.html
- /explore-empathy-platform/experience-search-and-discovery/facets-and-filters
- /explore-empathy-platform/experience-search-and-discovery/facets-and-filters.html
- /explore-empathy-platform/experience-search-and-discovery/facets-and-filters
---

Facets and Filters allow your shoppers to organize your product catalogue in different categories
Expand Down
4 changes: 2 additions & 2 deletions ...ges/x-components/static-docs/experience-search-and-discovery/history-queries.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: Design the History Queries UI experience
sidebar_title: History Queries UI
redirect_from:
- /explore-empathy-platform/experience-search-and-discovery/history-queries.html
- /explore-empathy-platform/experience-search-and-discovery/history-queries
- /explore-empathy-platform/experience-search-and-discovery/history-queries.html
- /explore-empathy-platform/experience-search-and-discovery/history-queries
---

The History Queries UI component displays the search history, allowing shoppers to check previous
Expand Down
4 changes: 2 additions & 2 deletions packages/x-components/static-docs/experience-search-and-discovery/id-results.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ sidebar_title: ID Results UI
tags:
- identifier results
redirect_from:
- /explore-empathy-platform/experience-search-and-discovery/id-results.html
- /explore-empathy-platform/experience-search-and-discovery/id-results
- /explore-empathy-platform/experience-search-and-discovery/id-results.html
- /explore-empathy-platform/experience-search-and-discovery/id-results
---

The Identifier Results UI component presents a type of search results intended for product reference
Expand Down
4 changes: 2 additions & 2 deletions packages/x-components/static-docs/experience-search-and-discovery/my-history.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: Design the My History UI experience
sidebar_title: My History UI
redirect_from:
- /explore-empathy-platform/experience-search-and-discovery/my-history.html
- /explore-empathy-platform/experience-search-and-discovery/my-history
- /explore-empathy-platform/experience-search-and-discovery/my-history.html
- /explore-empathy-platform/experience-search-and-discovery/my-history
---

The My History UI component displays the complete list of history queries, allowing shoppers to
Expand Down
11 changes: 6 additions & 5 deletions packages/x-components/static-docs/experience-search-and-discovery/next-queries.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ tags:
- popular next queries
- what's next
redirect_from:
- /explore-empathy-platform/experience-search-and-discovery/next-queries.html
- /explore-empathy-platform/experience-search-and-discovery/next-queries
- /explore-empathy-platform/experience-search-and-discovery/next-queries.html
- /explore-empathy-platform/experience-search-and-discovery/next-queries
---

The Next Queries UI component provides shoppers with ideas on what to search for next based on their
Expand All @@ -29,7 +29,8 @@ supports this feature.

::: interact

Can't quite capture the concept? Learn about [Next Queries](/understand-empathy-platform/search-features/next-queries-overview.md).
Can't quite capture the concept? Learn about
[Next Queries](/understand-empathy-platform/search-features/next-queries-overview.md).

:::

Expand Down Expand Up @@ -65,7 +66,7 @@ next queries that shoppers haven't already used in the session.
::: warning

To display only new next queries, the
[History Queries](/understand-empathy-platform/search-features/history-queries-overview.md) feature must be
implemented.
[History Queries](/understand-empathy-platform/search-features/history-queries-overview.md) feature
must be implemented.

:::
4 changes: 2 additions & 2 deletions ...es/x-components/static-docs/experience-search-and-discovery/popular-searches.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ tags:
- top queries
- trending
redirect_from:
- /explore-empathy-platform/experience-search-and-discovery/popular-searches.html
- /explore-empathy-platform/experience-search-and-discovery/popular-searches
- /explore-empathy-platform/experience-search-and-discovery/popular-searches.html
- /explore-empathy-platform/experience-search-and-discovery/popular-searches
---

The Popular Searches UI component displays what are the top search queries during a specific time.
Expand Down
4 changes: 2 additions & 2 deletions .../x-components/static-docs/experience-search-and-discovery/product-results-ui.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ sidebar_title: Product results UI
tags:
- results layout
redirect_from:
- /explore-empathy-platform/experience-search-and-discovery/product-results.html
- /explore-empathy-platform/experience-search-and-discovery/product-results
- /explore-empathy-platform/experience-search-and-discovery/product-results.html
- /explore-empathy-platform/experience-search-and-discovery/product-results
---

After launching a search, some shoppers may just want to take a quick look around, reviewing only
Expand Down
4 changes: 2 additions & 2 deletions ...s/x-components/static-docs/experience-search-and-discovery/query-suggestions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ tags:
- search suggestions
- search as you type
redirect_from:
- /explore-empathy-platform/experience-search-and-discovery/query-suggestions.html
- /explore-empathy-platform/experience-search-and-discovery/query-suggestions
- /explore-empathy-platform/experience-search-and-discovery/query-suggestions.html
- /explore-empathy-platform/experience-search-and-discovery/query-suggestions
---

The Query Suggestions UI component helps your shoppers with hints of what to look for to get
Expand Down
4 changes: 2 additions & 2 deletions packages/x-components/static-docs/experience-search-and-discovery/related-tags.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ tags:
- tags
- related keywords
redirect_from:
- /explore-empathy-platform/experience-search-and-discovery/related-tags.html
- /explore-empathy-platform/experience-search-and-discovery/related-tags
- /explore-empathy-platform/experience-search-and-discovery/related-tags.html
- /explore-empathy-platform/experience-search-and-discovery/related-tags
---

The Related Tags UI component helps your shoppers to refine a specific search query and find what
Expand Down
10 changes: 6 additions & 4 deletions packages/x-components/static-docs/experience-search-and-discovery/search-box.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ button.

::: interact

Can't quite capture the concept? Learn more about [Search Box](/understand-empathy-platform/search-basics/search-box-overview.md).
Can't quite capture the concept? Learn more about
[Search Box](/understand-empathy-platform/search-basics/search-box-overview.md).

:::

Expand All @@ -30,9 +31,10 @@ field to the selected suggestion and the search is launched.

::: warning

To modify the query syntax using [Query Suggestions](/understand-empathy-platform/search-features/query-suggestions-overview.md) or
[Next Queries](/understand-empathy-platform/search-features/next-queries-overview.md), make sure that your current search service
supports this type of feature.
To modify the query syntax using
[Query Suggestions](/understand-empathy-platform/search-features/query-suggestions-overview.md) or
[Next Queries](/understand-empathy-platform/search-features/next-queries-overview.md), make sure
that your current search service supports this type of feature.

:::

Expand Down
14 changes: 7 additions & 7 deletions packages/x-components/static-docs/experience-search-and-discovery/serp-ui.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ tags:
- grid
- results grid
redirect_from:
- /explore-empathy-platform/experience-search-and-discovery/serp-ui.html
- /explore-empathy-platform/experience-search-and-discovery/serp-ui
- /explore-empathy-platform/experience-search-and-discovery/serp-ui.html
- /explore-empathy-platform/experience-search-and-discovery/serp-ui
---

To handle and display search results, the layout of results and other related discovery features is
Expand Down Expand Up @@ -39,14 +39,14 @@ However, the grid is not the only element to consider when designing the SERP:
- Provide a **[sorting system](/explore-empathy-platform/overview/sorting-overview.md)** (D) so that
your shoppers can arrange results according to different criteria such as relevance, price,
alphabetical order…
- Include **[pagination](/understand-empathy-platform/search-basics/pagination-overview.md)** options to
browse results throughout the different result pages available or apply infinite scroll to ease
navigation.
- Include **[pagination](/understand-empathy-platform/search-basics/pagination-overview.md)**
options to browse results throughout the different result pages available or apply infinite scroll
to ease navigation.
- Apply **infinite scroll** to ease navigation and add a **scroll-to-top button** (E) to quickly
move to the top of the results page.
- Indicate your shoppers whether the
**[Spell Check](/understand-empathy-platform/search-features/spellcheck-overview.md)** feature is applied or
not.
**[Spell Check](/understand-empathy-platform/search-features/spellcheck-overview.md)** feature is
applied or not.

::: note

Expand Down
Loading

0 comments on commit b27f562

Please sign in to comment.