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.

Sign up for GitHub

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

Jump to bottom

doc: Sphinx search results are not helpful #55173

Closed
kartben opened this issue Feb 24, 2023 · 1 comment · Fixed by #60018
Closed

doc: Sphinx search results are not helpful #55173

kartben opened this issue Feb 24, 2023 · 1 comment · Fixed by #60018
Assignees
@kartben
Labels
area: Documentation Infrastructure area: Documentation Enhancement Changes/Updates/Additions to existing features

Comments

@kartben
Copy link
Collaborator

kartben commented Feb 24, 2023

We have a custom search result "scorer" that's hiding results that it shouldn't. More specifically, our code samples, supported boards, and available drivers, hardly ever make it to the top results, making it impossible for newcomers to quickly evaluate how far they will be to getting their idea implemented.

I will be working on improving the quality of the search results by removing as much of the custom scoring as possible, as it's doing more harm than good, and by refreshing it w.r.t to Sphinx improvements that have been added since it was initially implemented.
@kartben kartben added the Enhancement Changes/Updates/Additions to existing features label Feb 24, 2023
@kartben kartben self-assigned this Feb 24, 2023
kartben added a commit to kartben/zephyr that referenced this issue Feb 27, 2023
@kartben
doc: Stop downgrading samples & boards in search results
71c9686 
This fixes the custom scorer algorithm to make it more friendly towards
samples and boards. They will now appear more often, especially when
they're an exact match to the search query.
Fixes zephyrproject-rtos#55173.

Signed-off-by: Benjamin Cabé <[email protected]>
@kartben
Copy link
Collaborator Author

kartben commented Mar 1, 2023

Note to self: this https://github.com/jbms/sphinx-immaterial/ seems to have a pretty neat search experience. I might look into reusing their custom index builder that replaces the one that ships with Sphinx, as well as HTML and JS code for the interactive search.

@kartben kartben mentioned this issue Mar 27, 2023
Closed
kartben added a commit to kartben/zephyr that referenced this issue Mar 27, 2023
@kartben
doc: Switch to sphinx-immaterial theme
a21e330 
Attempt at fixing zephyrproject-rtos#55173.

Signed-off-by: Benjamin Cabé <[email protected]>
@kartben kartben mentioned this issue May 16, 2023
Closed
@kartben kartben mentioned this issue Jul 4, 2023
Merged
kartben added a commit to kartben/zephyr that referenced this issue Jul 12, 2023
@kartben
doc: Switch to sphinx-immaterial theme
34ceac9 
Attempt at fixing zephyrproject-rtos#55173.

Signed-off-by: Benjamin Cabé <[email protected]>
kartben added a commit to kartben/zephyr that referenced this issue Nov 7, 2023
@kartben
doc: Add Google Programmable Search Engine
444bab3 
Add Google Programmable Search engine to the documentation, while
leaving it possible to easily revert to the built-in Sphinx search
engine. As the styling of the search results is apparently not thought
to be easy to tweak, the gcs.css stylesheet might require further
improvements.
Fixes zephyrproject-rtos#55173.

Signed-off-by: Benjamin Cabé <[email protected]>
kartben added a commit to kartben/zephyr that referenced this issue Dec 11, 2023
@kartben
doc: Add Google Programmable Search Engine
5448405 
Add Google Programmable Search engine to the documentation, while
leaving it possible to easily revert to the built-in Sphinx search
engine. As the styling of the search results is apparently not thought
to be easy to tweak, the gcs.css stylesheet might require further
improvements.
Fixes zephyrproject-rtos#55173.

Signed-off-by: Benjamin Cabé <[email protected]>
nashif pushed a commit that referenced this issue Dec 15, 2023
@kartben @nashif
doc: Add Google Programmable Search Engine
7688f48 
Add Google Programmable Search engine to the documentation, while
leaving it possible to easily revert to the built-in Sphinx search
engine. As the styling of the search results is apparently not thought
to be easy to tweak, the gcs.css stylesheet might require further
improvements.
Fixes #55173.

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
Assignees

@kartben kartben

Labels
area: Documentation Infrastructure area: Documentation Enhancement Changes/Updates/Additions to existing features
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: Add Google Programmable Search Engine kartben/zephyr
1 participant
@kartben