rust-lang / rust-lang/rustup

`rustup doc --rustup` command to open the rustup book

Open
#2,714 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
22h 40m
Merged PRs (30d)
46

Description

Describe the problem you are trying to solve
rustup doc is capable of opening all kinds of rust books - alloc, cargo, embedded, nomicon, proc_macro, etc - however rustup can't open its own book.

Describe the solution you'd like
rustup doc --rustup should open the rustup book.

Notes
This would at least partially address online documentation being incoherent with the release a user has installed, or indeed incoherent with any currently available release #2713.

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 tracing the existing rustup doc command and how it selects the alloc, cargo, embedded, nomicon, and other books. Add support for --rustup so it opens the installed rustup book, then verify that the command opens the expected book.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
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.