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

Improve website search functionality #3172

Open
thomas-bc opened this issue Jan 30, 2025 · 1 comment
Open

Improve website search functionality #3172

thomas-bc opened this issue Jan 30, 2025 · 1 comment

Comments

@thomas-bc
Copy link
Collaborator

F´ Version
Affected Component Website

Feature Description

The website (https://fprime.jpl.nasa.gov/docs) has a search bar which works great for some things, but less for others.

For example, when searching a component name, one could expect that the component's SDD would be in the results. But this is often not the case. It's not clear to me why searching for the title of a page doesn't yield that exact page...

We should understand how the indexing of the search bar operates, and potentially make improvements to the docs (or search engine) to make search-ability better.

@thomas-bc
Copy link
Collaborator Author

Maybe we could use https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-boosting to boost SDDs...

My theory is also that the search engine might not be happy with our :: spelling, e.g. Svc::FileManager (yields no result in the search bar). Maybe Svc.FileManager in the SDD would fix it? 🤷

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant