doc: _extensions: kconfig: implement basic scoring of search results #98016
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This implements a few improvements to make Kconfig search results more relevant: - A match in a symbol's name is given more weight than a match in its prompt. - Field-length normalization is applied so that the shorter the field, the higher its relevance (e.g. searching for "sensor" will basically yield CONFIG_SENSOR as the top result as the query basically matches 100% of the symbol's name. Signed-off-by: Benjamin Cabé <[email protected]>
|
carlescufi
approved these changes
Oct 21, 2025
gmarull
approved these changes
Oct 21, 2025
|
Searching for etc. it would be nice if the percepio and log ones were places after all of the retained memory ones EDIT: I guess you could also just search for CONFIG_RETAIN... |
nordicjm
approved these changes
Oct 22, 2025
fabiobaltieri
approved these changes
Oct 22, 2025
kartben
added a commit
to kartben/zephyr
that referenced
this pull request
Oct 23, 2025
This implements the same improved sorting algorithm as was recently added to the documentation (see zephyrproject-rtos#98016), namely: - A match in a Kconfig symbol's name is given more weight than a match in its prompt. - Field-length normalization is applied so that the shorter the field, the higher its relevance (e.g. searching for "sensor" will now basically yield CONFIG_SENSOR as the top result as the query basically matches 100% of the symbol's name. Signed-off-by: Benjamin Cabé <[email protected]>
kartben
added a commit
to kartben/zephyr
that referenced
this pull request
Oct 23, 2025
This implements the same improved sorting algorithm as was recently added to the documentation (see zephyrproject-rtos#98016), namely: - A match in a Kconfig symbol's name is given more weight than a match in its prompt. - Field-length normalization is applied so that the shorter the field, the higher its relevance (e.g. searching for "sensor" will now basically yield CONFIG_SENSOR as the top result as the query basically matches 100% of the symbol's name. Signed-off-by: Benjamin Cabé <[email protected]>
kartben
added a commit
to kartben/zephyr
that referenced
this pull request
Oct 23, 2025
This implements the same improved sorting algorithm as was recently added to the documentation (see zephyrproject-rtos#98016), namely: - A match in a Kconfig symbol's name is given more weight than a match in its prompt. - Field-length normalization is applied so that the shorter the field, the higher its relevance (e.g. searching for "sensor" will now basically yield CONFIG_SENSOR as the top result as the query basically matches 100% of the symbol's name. Signed-off-by: Benjamin Cabé <[email protected]>
kartben
added a commit
to kartben/zephyr
that referenced
this pull request
Oct 23, 2025
This implements the same improved sorting algorithm as was recently added to the documentation (see zephyrproject-rtos#98016), namely: - A match in a Kconfig symbol's name is given more weight than a match in its prompt. - Field-length normalization is applied so that the shorter the field, the higher its relevance (e.g. searching for "sensor" will now basically yield CONFIG_SENSOR as the top result as the query basically matches 100% of the symbol's name. Signed-off-by: Benjamin Cabé <[email protected]>
kartben
added a commit
to kartben/zephyr
that referenced
this pull request
Oct 23, 2025
This implements the same improved sorting algorithm as was recently added to the documentation (see zephyrproject-rtos#98016), namely: - A match in a Kconfig symbol's name is given more weight than a match in its prompt. - Field-length normalization is applied so that the shorter the field, the higher its relevance (e.g. searching for "sensor" will now basically yield CONFIG_SENSOR as the top result as the query basically matches 100% of the symbol's name. Signed-off-by: Benjamin Cabé <[email protected]>
kartben
added a commit
to kartben/zephyr
that referenced
this pull request
Oct 23, 2025
This implements the same improved sorting algorithm as was recently added to the documentation (see zephyrproject-rtos#98016), namely: - A match in a Kconfig symbol's name is given more weight than a match in its prompt. - Field-length normalization is applied so that the shorter the field, the higher its relevance (e.g. searching for "sensor" will now basically yield CONFIG_SENSOR as the top result as the query basically matches 100% of the symbol's name. Signed-off-by: Benjamin Cabé <[email protected]>
kartben
added a commit
to kartben/zephyr
that referenced
this pull request
Oct 23, 2025
This implements the same improved sorting algorithm as was recently added to the documentation (see zephyrproject-rtos#98016), namely: - A match in a Kconfig symbol's name is given more weight than a match in its prompt. - Field-length normalization is applied so that the shorter the field, the higher its relevance (e.g. searching for "sensor" will now basically yield CONFIG_SENSOR as the top result as the query basically matches 100% of the symbol's name. Signed-off-by: Benjamin Cabé <[email protected]>
kartben
added a commit
to kartben/zephyr
that referenced
this pull request
Oct 23, 2025
This implements the same improved sorting algorithm as was recently added to the documentation (see zephyrproject-rtos#98016), namely: - A match in a Kconfig symbol's name is given more weight than a match in its prompt. - Field-length normalization is applied so that the shorter the field, the higher its relevance (e.g. searching for "sensor" will now basically yield CONFIG_SENSOR as the top result as the query basically matches 100% of the symbol's name. Signed-off-by: Benjamin Cabé <[email protected]>
kartben
added a commit
to kartben/zephyr
that referenced
this pull request
Oct 23, 2025
This implements the same improved sorting algorithm as was recently added to the documentation (see zephyrproject-rtos#98016), namely: - A match in a Kconfig symbol's name is given more weight than a match in its prompt. - Field-length normalization is applied so that the shorter the field, the higher its relevance (e.g. searching for "sensor" will now basically yield CONFIG_SENSOR as the top result as the query basically matches 100% of the symbol's name. Signed-off-by: Benjamin Cabé <[email protected]>
kartben
added a commit
to kartben/zephyr
that referenced
this pull request
Oct 23, 2025
This implements the same improved sorting algorithm as was recently added to the documentation (see zephyrproject-rtos#98016), namely: - A match in a Kconfig symbol's name is given more weight than a match in its prompt. - Field-length normalization is applied so that the shorter the field, the higher its relevance (e.g. searching for "sensor" will now basically yield CONFIG_SENSOR as the top result as the query basically matches 100% of the symbol's name. Signed-off-by: Benjamin Cabé <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This implements a few improvements to make Kconfig search results more relevant:
CONFIG_SENSORas the top result as the query basically matches 100% of the symbol's name.https://builds.zephyrproject.io/zephyr/pr/98016/docs/kconfig.html
I encourage folks to try out a few queries ("w1", "sensor", "tracing", ... are definitely huge improvements IMO) and confirm this is indeed an improvement.