Repository files navigation

Welcome to theRust Forge! Rust Forge serves as a repository of supplementarydocumentation useful for members ofThe Rust Programming Language.

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

mdbook build

This will build and run theblacksmith tool automatically. When developingit's recommended to use theserve command to launch a local server to allowyou to easily see and update changes you make.

mdbook serve

Forge uses JavaScript to display dates for releases and "no tools breakageweek". When making modifications to the JavaScript, make sure it matches thestandard style. You can installstandard and automatically format the codeusing the following commands.

#With Yarnyarn global add standard#With NPMnpm install --global standard

standard --fix js/

Any Rust team, working group, or project group can have a section in the Rust Forge.First, please send a PR to add your team to therepos/rust-lang/rust-forge.toml file to give your team permissions.

To add your team to the book, add it tosrc/SUMMARY.md, like below, replacing<TEAM_NAME> with a filesystem- and URL-friendly version of your team's name:

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

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

It's recommended that you put general team information insrc/<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)

Teams are responsible for merging their own content.Please add your team to the[assign.owners] section oftriagebot.toml so that the bot will auto-assign someone from the team.

TheRust infra team is responsible for maintaining the Rust Forge, ensuring that its build and publish system works, and coordinating any technical issues with teams.