qmk/qmk_firmware

[Bug] Docs search ranks results incorrectly

Open

#17,451 opened on Jun 22, 2022

View on GitHub
 (2 comments) (1 reaction) (0 assignees)C (43,867 forks)batch import
bugdocumentationhelp wanted

Repository metrics

Stars
 (20,368 stars)
PR merge metrics
 (Avg merge 20d 9h) (27 merged PRs in 30d)

Description

Describe the Bug

When I use the search on docs.qmk.fm, the search results do not obey any sort of logical (to me) ordering. As a simple example: If I enter "layers" as the search query, the doc page for the layers feature (feature_layers) is only the ninth search result.

I think part of the problem is that the search results point to sections, not pages. I can sort of see the benefit of this, but it runs contrary to how I expect most search engines to work. It means for example that a single page with many sections referring to the query string can crowd out the search results.

I find this a strong pain point when working with QMK, helping others out with understanding QMK features, etc. I can never rely on the search to give me what I want. I have mentally gotten used to typing a search term, clicking through to the first result, and then following a trail of breadcrumbs until I get where I actually wanted to be.

Contributor guide