Skip to content

Polish Jump to API search rows and dropdown chrome - #4153

Open
reakaleek wants to merge 2 commits into
feat/remove-jump-to-page-leftoversfrom
feat/jump-to-api-search-polish
Open

reakaleek wants to merge 2 commits into
feat/remove-jump-to-page-leftoversfrom
feat/jump-to-api-search-polish

Conversation

@reakaleek

@reakaleek reakaleek commented Sep 18, 2026

Copy link
Copy Markdown
Member

Jump to API result rows now show the operation name only. The product lives in the breadcrumb as API / Elasticsearch API, the input no longer shows a shortcut hint, and the dropdown footer drops the Alpha badge.

Affects: Site UI, API reference, Search

Prompt summary: After a local Jump to API check, follow up in a stacked PR: drop Alpha and Give feedback from the dropdown footer, make operation id and path easier to find, remove ⌘K from the text box, and show API instead of API reference in the crumb. Then put the product name (Kibana API, Elasticsearch API) in the breadcrumb instead of repeating it on every title.

Why

Each hit repeats Elasticsearch API or Kibana API in the title, so a query that matches the product name lights up every row. The breadcrumb shows the product slug (elasticsearch) instead of that label. Operation ids such as _bulk and paths such as PUT /_search are easy to type and hard to rank, because they sit only in the body or as a trailing token. The dropdown still carries Alpha chrome and a ⌘K hint in a box that already has focus.

What

Result title and breadcrumb

The indexed Title is the operation summary. The product label moves to the second breadcrumb, so a Kibana hit reads API / Kibana API above Search dashboards. The dropdown renders that title as stored. It does not strip a product suffix on display.

Search tokens

search_title still starts with that summary, then the product label, the raw operation id, and the HTTP method plus path. Dotted ids such as indices.get also get a space-separated form. Those extra tokens are for ranking only; they do not appear in the row title.

Dropdown chrome

The Jump to page input no longer paints ⌘K or Ctrl+K. Cmd+K still focuses the box. The footer keeps the keyboard hints and drops the Alpha badge and Give feedback link.

Verify

cd src/Elastic.Documentation.Site && npm run test -- --testPathPatterns='SearchResultsList.test|NavigationSearchTelemetry.test'
dotnet test tests/Elastic.ApiExplorer.Tests/ --filter 'FullyQualifiedName~OpenApiOperationIdSearchTitleTests'

Path and dotted-id ranking need an assembler index after this lands.

Out of scope: This does not change the full-page search result card, and it does not reindex a cluster.

Stack: 6 of 6, on top of #4148.

Made with Cursor

@github-actions github-actions Bot 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.

Requesting changes to address the inline comment before merge.


What is this? | From workflow: PR Review

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

reakaleek and others added 2 commits September 18, 2026 14:22
Result titles repeated "Elasticsearch API" and hid the product in a slug crumb, which made operation id and path queries harder to scan. Move the product label to the breadcrumb, keep ids and paths in search_title, and drop the Alpha footer chrome.

Co-Authored-By: Cursor Grok 4.6 <noreply@anthropic.com>
The exporter already stores the short summary as Title. A display-layer regex would hide a suffix that belongs in the source, not in the dropdown.

Co-Authored-By: Cursor Grok 4.6 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

Docs preview (local build)

Handbook preview: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/4153/

@github-actions github-actions Bot 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.

Approve: no actionable issues found.


What is this? | From workflow: PR Review

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant