Document search-metadata frontmatter key for Algolia records - #6789
Draft
fern-api[bot] wants to merge 2 commits into
Draft
Document search-metadata frontmatter key for Algolia records#6789fern-api[bot] wants to merge 2 commits into
fern-api[bot] wants to merge 2 commits into
Conversation
Contributor
|
🌿 Preview your docs: https://fern-preview-2026-08-31-fern-ai-fe3932-1c9a3500.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| The block is duplicated onto every record of a page, so keep it to the dimensions you actually facet on. | ||
| </Accordion> | ||
|
|
||
| Custom metadata is indexed for Markdown pages only. API reference and changelog records don't carry it. |
Contributor
There was a problem hiding this comment.
🚫 [vale] <FernStyles.Reject> reported by reviewdog 🐶
Use 'API Reference' instead of 'API reference'.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added a "Custom search metadata" section to the Search configuration page (between "Index external sitemaps" and "How results are ranked") explaining that Fern merges a page's
search-metadatafrontmatter mapping into its Algolia record, with string and array-value examples and a note that Fern's built-in search filters ignore these fields unless you configure Algolia facets and build or extend a search UI. Added a matching "Search metadata" subsection to the page settings reference with aParamField, the same example, and a link to the canonical section.