rust-lang / rust-lang/reference

More clearly document normative vs non-normative content

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

Nobody has claimed this yet.

A-conventions Authoring guide
Dominant language
Rust
Stars
1.6k
Forks
607
PR merge metrics
PR metrics pending

Description

I think it would be good to make it clear somehow what is normative vs non-normative. For example, notes are non-normative, but what else? How about the appendices? See C and C++ call these out in some places.

Are intro sections normative? I feel like we've been fairly inconsistent here.

I think it would be good if the introduction chapter called this out clearly, and then figure out sections that need to be called out one way or the other. The authoring guide should also provide some guidance on how to do all this.

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 reading the introduction chapter and the authoring guide, then review how notes, appendices, and intro sections are currently treated. Identify the sections needing explicit normative or non-normative guidance and update the introduction and authoring guidance so the distinction and authoring rules are clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.