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 search benchmarks #2417

Open
LilithHafner opened this issue Jan 21, 2024 · 3 comments
Open

Add search benchmarks #2417

LilithHafner opened this issue Jan 21, 2024 · 3 comments
Labels
Format: HTML Related to the default HTML output help wanted Type: Tests

Comments

@LilithHafner
Copy link
Contributor

LilithHafner commented Jan 21, 2024

It would be nice to have benchmarks to track search performance (i.e. ensuring that good results are ranked highly)

For example

Base.push! should rank above LibGit2.push! for the search query "push!" on docs.julialang.org. (it currently does not, adding a "boostDocument" function may help)

Feel free to contribute more candidate benchmarks to this thread. Ideally we could get them to run automatically in CI when folks propose changes to the searching/indexing functionality.

@mortenpi mortenpi added Type: Tests help wanted Format: HTML Related to the default HTML output labels Jan 21, 2024
@mortenpi
Copy link
Member

This seems like a good idea, if there's anyone who is willing to develop the infra and maintain it.

@LilithHafner
Copy link
Contributor Author

Is the existing test-system documented anywhere? If so, and if there are already end to end tests that navigate built html documentation with a headless browser, then it should be pretty easy to add these tests.

@mortenpi
Copy link
Member

Is the existing test-system documented anywhere?

No, not really, you'd have to follow the code. The test builds live in test/examples though, with the main entry points being test/examples/make.jl for building and test/examples/test.jl for doing some basic checks on the generated outputs. Any sort of docs/comments/refactorings are always welcome in the test code though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Format: HTML Related to the default HTML output help wanted Type: Tests
Projects
None yet
Development

No branches or pull requests

2 participants