README.md

The Rust Language Reference

This document is the primary reference for the Rust programming language.

Contributor docs

There are several pages for those working on the reference:

• Authoring guide: Guidelines for writing content.
• Review policy: Guidelines for reviewers.
• Grammar: How the grammar syntax works.
• Attribute template: The standard template for documenting an attribute.

Running tests

There are several different kinds of tests you can run (these are enforced on CI):

• mdbook test: This will run the inline Rust codeblocks (internally it uses rustdoc to do this).
• cargo xtask style-check: This will validate some style checks (see authoring guide).
• cargo xtask linkcheck: This will validate that markdown links aren't broken.
• cargo xtask test-all: Runs all tests.