rust-lang / rust-lang/rust

Add rustdoc JS search benchmark in performance checks

Open
#118,056 10 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

T-infra T-rustdoc
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

@notriddle wrote a tool to benchmark performance for the rustdoc search. I think it's an important enough topic to watch if there are any changes (both positive and negative). Only question is how to integrate it in the current tool.

Example of usage of the tool in https://github.com/rust-lang/rust/pull/118024.

cc @lqd @nnethercote (if you have any idea/suggestion?)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the rustdoc search benchmark tool and its example usage in rust-lang/rust#118024, then inspect the current performance-check tooling to determine the integration point. Done means the benchmark runs as part of the performance checks and its positive or negative changes can be monitored.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, rust
Domain
performance, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.