rust-lang / rust-lang/rust

contextless autocompletions for rustdoc search

Open
#131,708 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-rustdoc-search C-enhancement T-rustdoc T-rustdoc-frontend
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

recently i've come up with a "stateful prefix search" algorithm that allows fast prefix-based autocompletions from a pool of identifiers.

this algorithm should be fast enough to be responsive even on old devices.

this would provide a autocompletion popover with ~6 possibilites for identifiers.

these identifiers would be built from all crate names in the documentation workspace, all identifiers in the search index, and all rustdoc kind filters.

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 examining the rustdoc search UI and how its documentation workspace and search index expose identifiers. The proposed result should provide a responsive autocomplete popover with about six possibilities, combining crate names, indexed identifiers, and rustdoc kind filters.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.