Skip to content

Commit

Permalink
fix final broken links (#2534)
Browse files Browse the repository at this point in the history
  • Loading branch information
guimachiavelli authored Aug 21, 2023
1 parent cf8987e commit 656798c
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 9 deletions.
1 change: 0 additions & 1 deletion home.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ description: Everything you need to use Meilisearch.
# Documentation

Learn how to use Meilisearch in your projects by exploring our guides and API reference.
[example-link](/docs/learn/broken-link)

<Featured items={[
{
Expand Down
2 changes: 1 addition & 1 deletion learn/core_concepts/relevancy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ Custom ranking rules, instead, are always active once configured and will be use

### Ranking score

When using the [`showRankingScore` search parameter](/reference/api/search#show-ranking-score), Meilisearch adds a global ranking score field, `_rankingScore`, to each document. The `_rankingScore` is between `0.0` and `1.0`. The higher the ranking score, the more relevant the document.
When using the [`showRankingScore` search parameter](/reference/api/search#ranking-score), Meilisearch adds a global ranking score field, `_rankingScore`, to each document. The `_rankingScore` is between `0.0` and `1.0`. The higher the ranking score, the more relevant the document.

Ranking rules sort documents either by relevancy (`words`, `typo`, `proximity`, `exactness`, `attribute`) or by the value of a field (`sort`). Since `sort` doesn't rank documents by relevancy, it does not influence the `_rankingScore`.

Expand Down
2 changes: 1 addition & 1 deletion reference/api/facet_search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ For example, searching for `Jane` will return `Jane Austen`, but searching for `
| :---------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------- | :------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`facetName`** * | String | `null` | Facet name to search values on |
| **`facetQuery`** | String | `null` | Search query for a given facet value. If `facetQuery` isn't specified, Meilisearch performs a [placeholder search](/reference/api/search#placeholder-search) which returns all facet values for the searched facet, limited to 100 |
| [**`q`**](/reference/api/search#q) | String | `""` | Query string |
| [**`q`**](/reference/api/search#query-q) | String | `""` | Query string |
| **[`filter`](/reference/api/search#filter)** | [String*](/learn/fine_tuning_results/filtering#filter-expressions) | `null` | Filter queries by an attribute's value |
| **[`matchingStrategy`](/reference/api/search#matching-strategy)** | String | `last` | Strategy used to match query terms within documents |
| **[`attributesToSearchOn`](/reference/api/search##customize-attributes-to-search-on-at-search-time)** | Array of strings | `null` | Restrict search to the specified attributes |
Expand Down
4 changes: 2 additions & 2 deletions reference/api/multi_search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ If Meilisearch encounters an error when handling any of the queries in a multi-s
| **[`showMatchesPosition`](/reference/api/search#show-matches-position)** | Boolean | `false` | Return matching terms location |
| **[`sort`](/reference/api/search#sort)** | Array of strings | `null` | Sort search results by an attribute's value |
| **[`matchingStrategy`](/reference/api/search#matching-strategy)** | String | `last` | Strategy used to match query terms within documents |
| **[`showRankingScore`](/reference/api/search#show-ranking-score)** | Boolean | `false` | Display the global ranking score of a document |
| **[`attributesToSearchOn`](#customize-attributes-to-search-on-at-search-time)** | Array of strings | `["*"]` | Restrict search to the specified attributes |
| **[`showRankingScore`](/reference/api/search#ranking-score)** | Boolean | `false` | Display the global ranking score of a document |
| **[`attributesToSearchOn`](/reference/api/search#customize-attributes-to-search-on-at-search-time)** | Array of strings | `["*"]` | Restrict search to the specified attributes |

[Learn more about how to use each search parameter](/reference/api/search#search-parameters).

Expand Down
6 changes: 3 additions & 3 deletions reference/api/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ By default, [this endpoint returns a maximum of 1000 results](/learn/advanced/kn
| **[`showMatchesPosition`](#show-matches-position)** | Boolean | `false` | Return matching terms location |
| **[`sort`](#sort)** | Array of strings | `null` | Sort search results by an attribute's value |
| **[`matchingStrategy`](#matching-strategy)** | String | `last` | Strategy used to match query terms within documents |
| **[`showRankingScore`](#show-ranking-score)** | Boolean | `false` | Display the global ranking score of a document |
| **[`showRankingScore`](#ranking-score)** | Boolean | `false` | Display the global ranking score of a document |
| **[`attributesToSearchOn`](#customize-attributes-to-search-on-at-search-time)** | Array of strings | `["*"]` | Restrict search to the specified attributes |

[Learn more about how to use each search parameter](#search-parameters).
Expand Down Expand Up @@ -168,7 +168,7 @@ By default, [this endpoint returns a maximum of 1000 results](/learn/advanced/kn
| **[`showMatchesPosition`](#show-matches-position)** | Boolean | `false` | Return matching terms location |
| **[`sort`](#sort)** | Array of strings | `null` | Sort search results by an attribute's value |
| **[`matchingStrategy`](#matching-strategy)** | String | `last` | Strategy used to match query terms within documents |
| **[`showRankingScore`](#show-ranking-score)** | Boolean | `false` | Display the global ranking score of a document |
| **[`showRankingScore`](#ranking-score)** | Boolean | `false` | Display the global ranking score of a document |
| **[`attributesToSearchOn`](#customize-attributes-to-search-on-at-search-time)** | Array of strings | `["*"]` | Restrict search to the specified attributes |

[Learn more about how to use each search parameter](#search-parameters).
Expand Down Expand Up @@ -262,7 +262,7 @@ This is not necessary when using the `POST` route or one of our [SDKs](/learn/wh
| **[`showMatchesPosition`](#show-matches-position)** | Boolean | `false` | Return matching terms location |
| **[`sort`](#sort)** | Array of strings | `null` | Sort search results by an attribute's value |
| **[`matchingStrategy`](#matching-strategy)** | String | `last` | Strategy used to match query terms within documents |
| **[`showRankingScore`](#show-ranking-score)** | Boolean | `false` | Display the global ranking score of a document |
| **[`showRankingScore`](#ranking-score)** | Boolean | `false` | Display the global ranking score of a document |
| **[`attributesToSearchOn`](#customize-attributes-to-search-on-at-search-time)** | Array of strings | `["*"]` | Restrict search to the specified attributes |

### Query (q)
Expand Down
2 changes: 1 addition & 1 deletion reference/errors/error_codes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ The given [`uid`](/reference/api/keys#uid) is invalid. The `uid` must follow the

## `invalid_search_attributes_to_search_on`

The value passed to [`attributesToSearchOn`](/reference/api/search#select-attributes-to-search) is invalid. `attributesToSearchOn` accepts an array of strings indicating document attributes. Attributes given to `attributesToSearchOn` must be present in the [`searchableAttributes` list](/learn/index_settings/displayed_searchable_attributes#the-searchable-attributes-list).
The value passed to [`attributesToSearchOn`](/reference/api/search#customize-attributes-to-search-on-at-search-time) is invalid. `attributesToSearchOn` accepts an array of strings indicating document attributes. Attributes given to `attributesToSearchOn` must be present in the [`searchableAttributes` list](/learn/configuration/displayed_searchable_attributes#the-searchableattributes-list).

## `invalid_content_type`

Expand Down

0 comments on commit 656798c

Please sign in to comment.