From e5035c86c8b28c0172133b31d57208f9b7cf56f4 Mon Sep 17 00:00:00 2001 From: Alexis Aguilar <98043211+alexisintech@users.noreply.github.com> Date: Wed, 2 Apr 2025 12:03:50 -0400 Subject: [PATCH] (CONTRIBUTING.md) update explanation of the keywords prop for search --- CONTRIBUTING.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 615b975f85..2b11e1b1c0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -231,11 +231,11 @@ These fields should be present on every documentation page. The `search` frontmatter field can be used to control how a page is indexed by [Algolia Crawler](https://www.algolia.com/doc/tools/crawler/getting-started/overview/). It has the following subfields: -| Name | Type | Default | Description | -| ---------- | --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `exclude` | `boolean` | `false` | Whether to exclude the page from search entirely | -| `rank` | `number` | `0` | The value to use for `weight.pageRank` in the index. See [Custom Ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/) and [Boost search results with `pageRank`](https://docsearch.algolia.com/docs/record-extractor/#boost-search-results-with-pagerank) | -| `keywords` | `Array` | `[]` | Additional [searchable](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/) keywords to include when indexing the page. These are not visible to users. | +| Name | Type | Default | Description | +| ---------- | --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `exclude` | `boolean` | `false` | Whether to exclude the page from search entirely | +| `rank` | `number` | `0` | The value to use for `weight.pageRank` in the index. See [Custom Ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/) and [Boost search results with `pageRank`](https://docsearch.algolia.com/docs/record-extractor/#boost-search-results-with-pagerank) | +| `keywords` | `Array` | `[]` | Additional [searchable](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/) keywords to include when indexing the page. These are not visible to users. Due to Clerk's Algolia configuration, keywords have superiority over all other attributes; setting a keyword will rank that page higher than any other page. For example, the keyword "allowlist" is set on the [`restrictions.mdx`](/docs/authentication/configuration/restrictions.mdx) page so when searching for "allowlist", this page will be ranked above any other page. | You may also set `search` to a boolean value, which acts as an `exclude` value. See the first example below. @@ -251,6 +251,16 @@ You may also set `search` to a boolean value, which acts as an `exclude` value. --- ``` +or + +```diff + --- + title: Example ++ search: ++ exclude: true + --- +``` +