davidtwco / rust-forge

Information useful to people contributing to Rust

Rust Forge

Welcome to the Rust Forge! Rust Forge serves as a repository of supplementary documentation useful for members of The Rust Programming Language.

Development

You can build a local version by installing mdbook and running the following command.

mdbook build

This will build and run the blacksmith tool automatically. When developing it's recommended to use the serve command to launch a local server to allow you to easily see and update changes you make.

mdbook serve

JavaScript

Forge uses JavaScript to display dates for releases and "no tools breakage week". When making modifications to the JavaScript, make sure it matches the standard style. You can install standard and automatically format the code using the following commands.

Install commands

# With Yarn
yarn global add standard
# With NPM
npm install --global standard

Formatting

standard --fix js/

Contributing

Adding teams

Any Rust team can have a section in the Rust Forge. If you'd like to add your team, you first need to add them as an item to src/SUMMARY.md, like below, replacing TEAM NAME with your respective team's name to show on Forge, and <TEAM_NAME> with a filesystem- and URL-friendly version of that name where your documentation will be stored.

- [TEAM NAME](src/<TEAM_NAME>/README.md)
<!-- or -->
- [TEAM NAME](src/<TEAM_NAME>.md)

If you run mdbook build, mdbook will automatically create the folder and file for your team.

It's recommended that you put general team information in src/<TEAM_NAME>/README.md, such as where the meetings happen, repositories that the team manages, links to chat platforms, etc. Larger topics should be made as a subpage, e.g. (src/release/topic.md).

- [TOPIC](src/<TEAM_NAME>/TOPIC.md)