Skip to content

docs: document all available search filter options#4567

Merged
dannysheridan merged 4 commits intomainfrom
devin/1774546177-update-search-filters
Mar 26, 2026
Merged

docs: document all available search filter options#4567
dannysheridan merged 4 commits intomainfrom
devin/1774546177-update-search-filters

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration bot commented Mar 26, 2026

Summary

Updates the search configuration page to comprehensively document all search filter options available to Fern customers, replacing the previous incomplete list.

Filter list changes:

  • Replaced the old filter list (Versions, Endpoints, Guides, Changelog) with all seven available dropdown filters:
    • Product — filter by product (for multi-product sites)
    • Version — filter by documentation version
    • Content type — guides, changelog entries, or API endpoints
    • API type — HTTP, webhooks, WebSockets, or gRPC
    • HTTP method — GET, POST, PUT, DELETE, etc.
    • Status code — HTTP status code
    • Availability — Stable, Beta, Deprecated, and more
  • Updated the meta description to list all filters

Other text changes:

  • Removed adverb "quickly" (Vale FernStyles.Adverbs suggestion)
  • Fixed Vale Microsoft.Contractions error ("will not" → "won't")

Screenshot: Replaced filtering.png with a capture of the current search dialog showing the dropdown filters.

Updates since last revision

  • Removed {#integrating-with-algolia} heading anchor — it caused an MDX parse error (Could not parse expression with acorn) in CI
  • Replaced em dash (—) with colon in the API type filter description to avoid potential MDX parsing issues
  • Removed PATCH from the HTTP method example list to resolve a Vale FernStyles.Acronyms suggestion (PATCH is still supported as a filter value; it's just not listed in the example parenthetical)

Review & Testing Checklist for Human

  • Verify filter descriptions match actual customer-facing behavior — the list was derived from the SEARCHABLE_FACET_ATTRIBUTES and FACET_DISPLAY_NAME constants in fern-platform source code. Confirm all seven filters are actually exposed to customers and descriptions are accurate. In particular, verify that Status code and API type filters appear for customers who have the relevant content.
  • Verify internal links/learn/docs/configuration/products and /learn/docs/configuration/versions should both resolve correctly on the live site.
  • Review the screenshot — it was captured from Fern's own docs site and may not show all seven filters (e.g., Version and Availability may not appear if Fern's site doesn't use them). Consider whether a different screenshot would better represent the full set of filters.
  • Check whether PATCH should be re-added to the HTTP method example list — it was removed to satisfy a Vale acronym suggestion, but it's a common HTTP method customers may expect to see mentioned.

Suggested test plan: Open the preview deployment, navigate to the search page, and confirm the filter list renders correctly. Cross-reference against a customer site that uses versioned docs or availability badges to verify those filters appear in practice.

Notes

  • One remaining Vale suggestion (heading capitalization for "Integrating with Algolia") is a false positive — "Algolia" is a proper noun.

Link to Devin session: https://app.devin.ai/sessions/4b6548ef176249b89a5af31df728c207

Update the search configuration page to reflect the current dropdown-based
filtering system (Product, Content type, HTTP method) replacing the outdated
filter list (Versions, Endpoints, Guides, Changelog). Replace the filtering
screenshot with an updated capture of the current search UI.

Requested by: Fern Support

Co-Authored-By: bot_apk <apk@cognition.ai>
@devin-ai-integration devin-ai-integration bot requested a review from devalog as a code owner March 26, 2026 17:32
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 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 and CI monitoring

@fern-api
Copy link
Copy Markdown
Contributor

fern-api bot commented Mar 26, 2026

Requested by: devin
Slack thread: View conversation

@github-actions
Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://fern-preview-devin-1774546177-update-search-filters.docs.buildwithfern.com/learn

Here are the markdown pages you've updated:

Co-Authored-By: bot_apk <apk@cognition.ai>
</Note>

## Integrating with Algolia
## Integrating with Algolia {#integrating-with-algolia}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Integrating with Algolia {#integrating-with-algolia}' should use sentence-style capitalization.

@devin-ai-integration devin-ai-integration bot changed the title docs: update search filtering options to match current UI docs: document all available search filter options Mar 26, 2026
@dannysheridan dannysheridan merged commit 924ff93 into main Mar 26, 2026
2 checks passed
@dannysheridan dannysheridan deleted the devin/1774546177-update-search-filters branch March 26, 2026 19:17
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