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

Add Ability to actually Search the docs for keywords. #91

Open
dellis1972 opened this issue Dec 30, 2024 · 2 comments
Open

Add Ability to actually Search the docs for keywords. #91

dellis1972 opened this issue Dec 30, 2024 · 2 comments

Comments

@dellis1972
Copy link
Contributor

People do not use our docs it seems.
Our current indexing is in adiquate. It does not allow users to search for specific topics or keywords. Only for titles on existing pages, which suggest you need to know which page you want in the first place.

We should add the ability to search for words and filter the docs accordingly.

@kimmcintyre
Copy link
Contributor

kimmcintyre commented Jan 12, 2025

It looks like DocFX templates have this metadata field called _enableSearch which can be applied to the globalMetaData object in the docfx.json to add a search bar to the site. The search results aren't amazing but you can generally search by a class name and get the class's page as the first result. Here's the search bar on my local doc site returning results for DepthStencilState.

image

Do you think that enabling DocFX's search bar is sufficient for this issue?

edit: I dived a bit deeper into how DocFX's search engine works. It's actually just lunr.js under the hood so refined search queries are possible based on lunr's doc.

@dellis1972
Copy link
Contributor Author

@kimmcintyre if it works feel free to post a PR, I think it will help allot of people to be able to search for things.

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

No branches or pull requests

2 participants