Skip to content

GRWMK-419: Improve Algolia Search Experience - #5251

Draft
davidcarlsonberg wants to merge 3 commits into
mainfrom
grwmk-419/improve-algolia-search-experience
Draft

GRWMK-419: Improve Algolia Search Experience#5251
davidcarlsonberg wants to merge 3 commits into
mainfrom
grwmk-419/improve-algolia-search-experience

Conversation

@davidcarlsonberg

Copy link
Copy Markdown
Contributor

⚠️ DO NOT MERGE unless ALGOLIA_SEARCH_API_KEY and ALGOLIA_INDEX_NAME have been changed back to the expected, production (not experimental) values.
⚠️ To support these changes, there are changes that should occur first in the Algolia Dashboard, namely to the Crawler and the Index that support Docs and Learn.

What does this PR do?

  • Uses the experimental Algolia index to evaluate search improvements without changing production search.
  • Adds inline SDK context to ambiguous results, for example Quickstart - Ruby SDK.
  • Avoids repeating the SDK label when it is already included in a result title.
  • Adds hierarchy context to section results so readers can identify the source page and area.
  • Shows matched content snippets for content-bearing results, including section-level results.
  • Retains category grouping while making SDK-specific results easier to distinguish.
  • Supports Algolia Dashboard query rules that promote SDK landing pages for exact SDK-name searches.
  • Evaluates an experimental crawler configuration that indexes headings through H3 rather than H6 to reduce noisy, low-value results.

Notes to reviewers

  • Test navigational queries: Quickstart, Java, and Workflow.
  • Test conceptual queries: what is durable execution and how do I start a Workflow.
  • Snippets appear when Algolia returns a content-bearing record. Title and heading matches may return heading records with no content snippet.
  • The experimental crawler and index configuration are managed in the Algolia Dashboard, not in this repository.

@davidcarlsonberg davidcarlsonberg self-assigned this Sep 4, 2026
Copilot AI balanced review requested due to automatic review settings September 4, 2026 18:33
@vercel

vercel Bot commented Sep 4, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
temporal-documentation Ready Ready Preview Sep 4, 2026 7:15pm UTC

Request Review

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

📖 Docs PR preview links

This PR does not change any pages in /docs. If you make updates, links to the modified pages will appear here.

Copilot AI left a comment

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.

🟡 Changes recommended

The description explicitly requires restoring the production Algolia key and index before merge.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Updates the custom search UI to clarify SDK-specific results and display hierarchy paths and snippets.

Changes:

  • Adds SDK labels and hierarchy context to search hits.
  • Groups results by SDK language.
  • Switches Algolia to an experimental index and API key.
File summaries
File Description
src/theme/SearchBar/styles.css Styles SDK labels and reformats transitions.
src/theme/SearchBar/Hit.tsx Displays SDK, hierarchy, and snippet context.
src/theme/SearchBar/GroupedHits.tsx Groups and disambiguates SDK-specific results.
src/constants/algolia.js Selects the experimental Algolia index.
Review details
  • Files reviewed: 4/4 changed files
  • Comments generated: 0
  • Review effort level: Balanced

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

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