Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(redirections): added redirections in metadata #1341

Merged
merged 2 commits into from
Oct 27, 2023
Merged

docs(redirections): added redirections in metadata #1341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c849f28
docs(redirections): added redirections in metadata
mlcorton Oct 26, 2023
b27f562
docs: add prettier changes
herrardo Oct 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions ...ges/x-components/static-docs/build-search-ui/web-archetype-integration-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,13 +308,13 @@ 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. |
| `addProductToCart` | `productId` - _Optional._ Id of the product added to cart | Sends tracking of the `AddToCart` event to the [Empathy Tagging microservice](https://docs.empathy.co/develop-empathy-platform/capture-interaction-signals/tagging-api-guide.html) 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. |
| 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
2 changes: 1 addition & 1 deletion ...s/x-components/static-docs/build-search-ui/web-how-to-use-x-components-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ The `search-box` module contains these components:
::: interact

Learn more about the
[Search Box UI](/explore-empathy-platform/experience-search-and-discovery/search-box.md)
[Search Box UI](/onboard-empathy-platform/experience-search-and-discovery/search-box.md)

:::

Expand Down
3 changes: 2 additions & 1 deletion packages/x-components/static-docs/experience-search-and-discovery/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
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/
---

Search inevitably is key when people look for specific products in an online store. It's the door to
Expand All @@ -14,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
19 changes: 12 additions & 7 deletions packages/x-components/static-docs/experience-search-and-discovery/empathize.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +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
---

Empathize is a UI container, but not just any container. It’s the
**[predictive layer](/explore-empathy-platform/overview/predictive-layer.md)** for your search
experience that is usually displayed below the search box. Consider it the natural companion of the
**[search box](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 @@ -25,12 +29,13 @@ Being the face of your predictive layer, Empathize comes into play before the se
and only makes sense when used with other components.

Thanks to the nature of Interface X Components, you can
[mix and match the components](/explore-empathy-platform/experience-search-and-discovery/readme.md#mix-and-match-your-experience)
[mix and match the components](/onboard-empathy-platform/experience-search-and-discovery/readme.md#mix-and-match-your-experience)
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](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
5 changes: 4 additions & 1 deletion .../x-components/static-docs/experience-search-and-discovery/facets-and-filters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ title: Design the Facets and Filters UI experience
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
---

Facets and Filters allow your shoppers to organize your product catalogue in different categories
Expand All @@ -28,7 +31,7 @@ having to search.-->
::: interact

Can't quite capture the concept? Learn more about
[Facets and Filters](../overview/facets-and-filters-overview.md).
[Facets and Filters](/understand-empathy-platform/search-basics/facets-and-filters-overview.md).

:::

Expand Down
5 changes: 4 additions & 1 deletion ...ges/x-components/static-docs/experience-search-and-discovery/history-queries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
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
---

The History Queries UI component displays the search history, allowing shoppers to check previous
Expand All @@ -11,7 +14,7 @@ searches and revisit products they’ve viewed before in a few clicks.
::: interact

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

:::

Expand Down
5 changes: 4 additions & 1 deletion packages/x-components/static-docs/experience-search-and-discovery/id-results.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ title: Design the ID Results UI experience
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
---

The Identifier Results UI component presents a type of search results intended for product reference
Expand All @@ -22,7 +25,7 @@ correct performance, make sure that your current search service supports this ty
::: interact

Don't quite understand ID results? Learn more about
[ID Results](../features/id-results-overview.md).
[ID Results](/understand-empathy-platform/search-features/id-results-overview.md).

:::

Expand Down
5 changes: 4 additions & 1 deletion packages/x-components/static-docs/experience-search-and-discovery/my-history.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
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
---

The My History UI component displays the complete list of history queries, allowing shoppers to
Expand All @@ -24,7 +27,7 @@ shoppers to enable or disable search history.

To show the complete list of history queries, My History component uses the history records saved on
the shopper’s browser local history. See
[Interface X data privacy and browser local storage](/explore-empathy-platform/experience-search-and-discovery/web-local-storage.md)
[Interface X data privacy and browser local storage](/onboard-empathy-platform/experience-search-and-discovery/web-local-storage.md)
to check out the information stored locally on the shopper’s device.

:::
Expand Down
10 changes: 7 additions & 3 deletions packages/x-components/static-docs/experience-search-and-discovery/next-queries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ sidebar_title: Next Queries UI
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
---

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

::: interact

Can't quite capture the concept? Learn about [Next Queries](../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 @@ -62,7 +66,7 @@ next queries that shoppers haven't already used in the session.
::: warning

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

:::
5 changes: 4 additions & 1 deletion ...es/x-components/static-docs/experience-search-and-discovery/popular-searches.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ tags:
- search trends
- top queries
- trending
redirect_from:
- /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 All @@ -26,7 +29,7 @@ feature.
::: interact

Can't quite capture the concept? Learn about
[Popular Searches](../features/popular-searches-overview.md).
[Popular Searches](/understand-empathy-platform/search-features/popular-searches-overview.md).

:::

Expand Down
7 changes: 5 additions & 2 deletions .../x-components/static-docs/experience-search-and-discovery/product-results-ui.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ title: Design the product results UI experience
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
---

After launching a search, some shoppers may just want to take a quick look around, reviewing only
Expand Down Expand Up @@ -72,8 +75,8 @@ experience.

Traditionally, search results are displayed on the SERP after the query is launched or instantly as
you type. However, result data is also used by features such as
[Recommendations](/explore-empathy-platform/experience-search-and-discovery/recommendations.md) and
[ID Results](/explore-empathy-platform/experience-search-and-discovery/id-results.md). You can
[Recommendations](/onboard-empathy-platform/experience-search-and-discovery/recommendations.md) and
[ID Results](/onboard-empathy-platform/experience-search-and-discovery/id-results.md). You can
combine results-related components with these modules to get advanced display options. Include
additional product information in Recommendations and Identifier Results such as prices and pictures
for better recognition and understanding of the products displayed.
5 changes: 4 additions & 1 deletion ...s/x-components/static-docs/experience-search-and-discovery/query-suggestions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ sidebar_title: Query Suggestions UI
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
---

The Query Suggestions UI component helps your shoppers with hints of what to look for to get
Expand All @@ -23,7 +26,7 @@ type of feature.
::: interact

Can't quite capture the concept? Learn more about
[Query Suggestions](../features/query-suggestions-overview.md).
[Query Suggestions](/understand-empathy-platform/search-features/query-suggestions-overview.md).

:::

Expand Down
5 changes: 4 additions & 1 deletion packages/x-components/static-docs/experience-search-and-discovery/related-tags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ sidebar_title: Related Tags UI
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
---

The Related Tags UI component helps your shoppers to refine a specific search query and find what
Expand All @@ -17,7 +20,7 @@ Platform Interface X supports displaying them anywhere on the SERP instead.
::: interact

Can't quite capture the concept? Learn more about
[Related Tags](../features/related-tags-overview.md).
[Related Tags](/understand-empathy-platform/search-features/related-tags-overview.md).

:::

Expand Down
13 changes: 9 additions & 4 deletions packages/x-components/static-docs/experience-search-and-discovery/search-box.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ tags:
- search bar
- search field
- input
redirect_from:
- /explore-empathy-platform/experience-search-and-discovery/search-box.html
- /explore-empathy-platform/experience-search-and-discovery/search-box
---

The Search Box UI Component is the main entry point for search where shoppers can type what
Expand All @@ -16,7 +19,8 @@ button.

::: interact

Can't quite capture the concept? Learn more about [Search Box](../overview/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 @@ -27,9 +31,10 @@ field to the selected suggestion and the search is launched.

::: warning

To modify the query syntax using [Query Suggestions](../features/query-suggestions-overview.md) or
[Next Queries](../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
Loading