Skip to content

docs: document search-metadata frontmatter for Algolia faceting - #6802

Merged
Ryan-Amirthan merged 1 commit into
mainfrom
devin/1788267295-search-metadata-docs
Sep 1, 2026
Merged

docs: document search-metadata frontmatter for Algolia faceting#6802
Ryan-Amirthan merged 1 commit into
mainfrom
devin/1788267295-search-metadata-docs

Conversation

@Ryan-Amirthan

Copy link
Copy Markdown
Contributor

Summary

Documents the search-metadata frontmatter 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 metadata under 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_metadata record 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, tagged search, frontmatter.

fern check --warnings and Vale pass (remaining Vale suggestion on ## Integrating with Algolia is 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

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

@Ryan-Amirthan
Ryan-Amirthan merged commit ff3e6ef into main Sep 1, 2026
5 checks passed
@Ryan-Amirthan
Ryan-Amirthan deleted the devin/1788267295-search-metadata-docs branch September 1, 2026 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants