Reimagining docs navigation

[chandlerprall]

We've been discussing ways to improve the navigation and search experiences in the EUI docs. Starting a discussion to collect ideas/examples, let's start with just gathering ideas, anything from small improvements to pie-in-the-sky :amaze:, collecting each idea in a top-level comment so it can have a threaded conversation.

[chandlerprall]

Search experience - UI

We've had a previous proposal to use EuiSelectableTemplateSitewide, which would align our docs with the search experience built for Kibana.

❓Should a keyboard shortcut toggle this? Common ones include cmd/ctrl+t, cmd/ctrl+k, t, and /

❓Are there other types of items that could be available in these results, like actions? Switch the theme, perhaps?

[chandlerprall]

Search experience - content

Search terms

We currently have a naive exact-match search against page and section titles. This has lead to a situation where it's common to search for a component by name, and then the desired section, rather than trying to guess an exact-text match of the section name. This screenshot of the datagrid nav is a good example:

Ideally, we want to move to a setup that relies on Enterprise Search for indexing & searching content, which would give control over the searchable terms and weightings for results.

Results

I can't think of a page we wouldn't want to make searchable, can always revisit that as a decision in the future too.

❓What data should be presented to a user in a result?

[chandlerprall]

Navigation UI

A number of designs, issues, PRs, etc have discussed creating top-level sections like Guidelines | Components | Theming to the header.

❓What depth of content organization should be supported
❓What depth of navigation should be supported