docs: document search-metadata frontmatter for Algolia faceting - #6802
Merged
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1788267295-search-metadata-docs.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
devalog
approved these changes
Sep 1, 2026
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
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.
Summary
Documents the
search-metadatafrontmatter block shipped in fern-api/fern-platform#14223. Replaces the draft in #6794, whose content didn't match the implementation: it claimed values must be strings and keys must be alphanumeric + hyphens, and it described the block as merely "stored on the record" without the record attribute name or the facet paths customers query by.Three edits:
customization/search.mdx: new### Facet on custom page metadataunder Integrating with Algolia (next to "Making search requests", since the attributes are only reachable through the Algolia API — not under "How search works", where the draft put it). Covers the frontmatter →search_metadatarecord attribute mapping, faceting by full path (facets: ["search_metadata.discovery.technology_tags"],facetFilters: [["search_metadata.audience:gardener"]]), the accepted value types (string/number/boolean/date/array/nested object), and the sanitizer's real constraints: keys containing:or.dropped, subtrees past depth 5 dropped, whole block dropped past 4KB. Also scopes it to markdown pages and notes it's absent from Fern's built-in filter bar.navigation/frontmatter.mdx:<ParamField path="search-metadata">pointing at the canonical section.changelog/2026-09-01.mdx: new entry, taggedsearch, frontmatter.fern check --warningsand Vale pass (remaining Vale suggestion on## Integrating with Algoliais pre-existing).Link to Devin session: https://app.devin.ai/sessions/973cdd79ce9a46699ac687616576445a
Open in Devin Desktop: https://app.devin.ai/desktop/session/973cdd79ce9a46699ac687616576445a?variant=devin
Requested by: @Ryan-Amirthan