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

Implement site-wide search #66

Open
eecavanna opened this issue Dec 8, 2024 · 0 comments
Open

Implement site-wide search #66

eecavanna opened this issue Dec 8, 2024 · 0 comments
Assignees
@eecavanna
Labels
backlog backlogged to be reprioritized in the future enhancement New feature or request x small less than 1 day

Comments

@eecavanna
Copy link
Collaborator

Members of the documentation squad briefly discussed having a global search box on the homepage of the documentation website.

Regarding technologies:

  • MkDocs uses lunr as its search tool. Based on what I see on the GitHub repository page for lunr, I don't think the tool is actively maintained anymore (the last commit was made 4 years ago). However, MkDocs is still using it.
  • I think Sphinx has it own homegrown search tool.
@eecavanna eecavanna added backlog backlogged to be reprioritized in the future enhancement New feature or request x small less than 1 day labels Dec 8, 2024
@eecavanna eecavanna self-assigned this Dec 8, 2024
@eecavanna eecavanna changed the title Implement side-wide search Implement site-wide search Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@eecavanna eecavanna

Labels
backlog backlogged to be reprioritized in the future enhancement New feature or request x small less than 1 day
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@eecavanna