Feature Request: Sidebar search filter

[josegonzalez]

Contribution guidelines

• I've read the contribution guidelines and wholeheartedly agree

I want to suggest an idea and checked that ...

• ... to my best knowledge, my idea wouldn't break something for other users
• ... the documentation does not mention anything about my idea
• ... there are no open or closed issues that are related to my idea

Description

This is something I noticed in the Hashicorp docs. There is a sidebar filter (under the version dropdown) that folks can use to filter what is shown in the sidebar. While I don't think it should be the default (especially for smaller doc sites) it can be useful for larger doc sites (or those with many embedded pages).

Use Cases

The dokku docs have a very long sidebar, and it would be nice to be able to filter things.

Screenshots / Mockups

Attached is a screen recording of the usage of the docs site:

Screen.Recording.2022-09-19.at.4.28.41.PM.mov

[squidfunk]

I've evaluated this feature request and would currently not consider it a good fit, because we already have the unified site-wide search as an entrypoint. While I understand that filtering the navigation might sometimes yield a little more information than using the search which lists pages by relevance, it's probably not generalizable enough to provide good value for all users. It might be too specific for API documentation.

We might re-evaluate in the future, but currently, this feature is considered out-of-scope.

[squidfunk]

Also note that this is loosely related to #3787, which IMHO is more generalizable.