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

Improve Search #645

Open
plumbis opened this issue Dec 2, 2023 · 1 comment
Open

Improve Search #645

plumbis opened this issue Dec 2, 2023 · 1 comment
Labels
enhancement New feature or request feature Requests for new features in docs infra or content infrastructure Issues related to the docs HTML, CSS, JS or hosting P4 Lowest priority issues. Given time and resources it will be addressed eventually.

Comments

@plumbis
Copy link
Collaborator

plumbis commented Dec 2, 2023 •
edited

The currently implemented DocSearch isn't very good.

Some current problems:

  • The API docs aren't index because the records are too large
  • Searching for specific code terms like MatchInteger don't provide precise results (takes you to the page, but not the heading)
  • Search results are so truncated that it's hard to know if the result is the one you want

Fix this is going to require rebuilding our index and the search results panel.
@plumbis plumbis added enhancement New feature or request feature Requests for new features in docs infra or content P1 Must fix, critical issues. Frequent or wide-spread user impact. labels Dec 2, 2023
@plumbis plumbis self-assigned this Dec 6, 2023
@plumbis plumbis changed the title Ensure APIs are indexed for search Improve Search Dec 8, 2023
@plumbis plumbis added P2 Should fix, important issues. Some user impact infrastructure Issues related to the docs HTML, CSS, JS or hosting P3 Nice to have issues. Should be prioritized to be eventually resolved. and removed P1 Must fix, critical issues. Frequent or wide-spread user impact. P2 Should fix, important issues. Some user impact labels Dec 8, 2023
@plumbis
Copy link
Collaborator Author

plumbis commented Feb 15, 2024

This is a big challenge and outside my ability. I'm not going to close but I'm deprioritizing.

@plumbis plumbis added P4 Lowest priority issues. Given time and resources it will be addressed eventually. and removed P3 Nice to have issues. Should be prioritized to be eventually resolved. labels Feb 15, 2024
@plumbis plumbis removed their assignment Feb 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request feature Requests for new features in docs infra or content infrastructure Issues related to the docs HTML, CSS, JS or hosting P4 Lowest priority issues. Given time and resources it will be addressed eventually.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@plumbis