rust-lang / rust-lang/fls

Search function (in the rendered document) is severely limited

Open
#666 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
reStructuredText
Stars
497
Forks
41
Avg merge
3h 52m
Merged PRs (30d)
4

Description

For triaging an issue over at the safety critical guidelines repo, I'm trying to figure out where some of the definitions, used in the rule for which the bug was reported, came from. For this, the fastest way (if the FLS ID doesn't cover it) is to look for the information being quoted in the rule.

But I can't do that in the FLS' page. I can only search for item titles, when what I need to find is a specific phrase.

I hope this is the right place to ask for this. Cheers 🤗

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 with the rendered FLS page and inspect how its current search is limited to item titles. Trace the page's search entry point and make it find specific phrases in the quoted rule text; done means users can search the rendered document's full text, not only item titles.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, search
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.