qmk/qmk_firmware

[Bug] Docs search ranks results incorrectly

Open

#17,451 建立於 2022年6月22日

在 GitHub 查看
 (2 留言) (1 反應) (0 負責人)C (43,867 fork)batch import
bugdocumentationhelp wanted

倉庫指標

Star
 (20,368 star)
PR 合併指標
 (平均合併 20天 9小時) (30 天內合併 27 個 PR)

描述

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.

貢獻者指南