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

De-boost reference docs; add search gadgets #671

Merged
merged 2 commits into from
Sep 6, 2024
Merged

Conversation

brynpickering
Copy link
Member

Fixes #670

Summary of changes in this pull request

  • De-ranked API (0.5) / schema (0.25) docs
  • Added search suggestions, sharing, and result highlighting, since we can.

Reviewer checklist

  • Test(s) added to cover contribution
  • Documentation updated
  • Changelog updated
  • Coverage maintained or improved

Copy link
Contributor

@irm-codebase irm-codebase left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checked the results in the documentation.
Much better, but there is still quite some spam (the sidebar looks very 'long' for most searches).
I think this happens because mkdocs includes whole notebook sections in the search, even if only a single word was hit.

source_use_equals leads to an artificially large search (the 'ghost' bar in the picture).
I'm ok with the change, but I think it would be improved by completely omitting notebooks.

image

@irm-codebase
Copy link
Contributor

Also, the new hints and highlights are much appreciated!

@irm-codebase
Copy link
Contributor

Approved since the notebooks / search bar thing is kind of a separate issue.

@brynpickering brynpickering merged commit 389e9f2 into main Sep 6, 2024
4 checks passed
@brynpickering brynpickering deleted the update-doc-search branch September 6, 2024 07:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Ommit long files from search (schemas)
2 participants