rust-lang / rust-lang/fls

Make it easier to find the FLS ID in the rendered document

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

Nobody has claimed this yet.

A-meta C-enhancement S-waiting-on-review
Dominant language
reStructuredText
Stars
497
Forks
41
Avg merge
3h 52m
Merged PRs (30d)
4

Description

The current method to identify an FLS ID is a little clunky.

Having it be visible e.g. on hover over the section numbering would be nice.

Brought up initially here.

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

No file or test is named. Start by tracing how section numbering is rendered in the FLS document and read the discussion linked from PR #585. Done means the FLS ID is easier to discover, such as by hovering over the section numbering, with the rendered result matching the intended behavior.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.