Make readme content easier to find
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 22h 40m
- Merged PRs (30d)
- 46
Description
Much of the information describing exactly what rustup does, how it works, etc. is contained in README.md. However, it's not very discover-able (based on user feedback).
We do link to it from a small "about rustup" link on rustup.rs but it's not at all obvious. We should consider one or more of:
- Having a more prominent link from the site
- Linking to the readme from the initial rustup installation welcome message and help text
- Installing the readme to a file as part of rustup's installation
- Having a command in rustup to view the readme
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading README.md and the current "about rustup" link on rustup.rs, then inspect the initial installation welcome message and help text. Compare the listed discovery options and determine which approach is selected; done means users can find the README content through the chosen rustup or website entry point.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100