Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make better use of search metadata for filtering searches #33

Open
caro401 opened this issue Feb 20, 2024 · 0 comments
Open

Make better use of search metadata for filtering searches #33

caro401 opened this issue Feb 20, 2024 · 0 comments
Labels
docs-platform things that need doing to the code for the docs platform to make it more useful question Further information is requested

Comments

@caro401
Copy link
Collaborator

caro401 commented Feb 20, 2024

The search provider for the docs pagefind allows you to annotate bits of a page with specific metadata, to help filter down to relevant results when you're searching. Currently the filters available in the search are only applied to the auto-generated plugin docs, and the filter values are a relic of a past experiment.

You can see the currently available filters in the search box - type anything, and notice at the top of the results there's some sections module, author, tags etc, which contain checkboxes. Checking any of the checkboxes reduces your search results to just pages with metadata that matches the boxed you checked.

image

We should have a think about how users generally want to filter down search results in the docs. One idea was to filter by different page/content types (#32 which can be done entirely in this repo), but I think other things like references to specific operations/modules, or plugins (at a specific version) might also be helpful? This will require updates in the DHARPA-Project/kiara-svelte-components repo to implement.

Any feedback from docs users about how you'd like to be able to filter your searching would be really helpful!

@caro401 caro401 added question Further information is requested docs-platform things that need doing to the code for the docs platform to make it more useful labels Feb 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-platform things that need doing to the code for the docs platform to make it more useful question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant