rust-lang / rust-lang/reference

Appendix: History of the document

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

Nobody has claimed this yet.

Dominant language
Rust
Stars
1.6k
Forks
607
PR merge metrics
PR metrics pending

Description

I'm proposing adding a new appendix that describes the history of the reference and why it has multiple layers of quality depending on what you are looking at. We could also spend some time describing the rationale for why we're not going for a normative document in it.

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

Review the Rust Reference's current organization and identify where an appendix on its history would fit. Document why the reference has multiple quality layers and explain the rationale for not making it normative; the appendix is done when both topics are clearly covered in the reference.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.