Skip to content

Commit 4a8d5e1

Browse files
XAMPPRockyjyn514
andauthored
Add documentation on adding teams to forge. (#308)
* Add documentation on adding teams. * Update README.md * Update README.md Co-Authored-By: Joshua Nelson <[email protected]> Co-authored-by: Joshua Nelson <[email protected]>
1 parent abc4771 commit 4a8d5e1

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,23 @@ npm install --global standard
4646
```bash
4747
standard --fix js/
4848
```
49+
50+
# Contributing
51+
52+
## Adding Teams
53+
54+
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 so 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.
55+
56+
```markdown
57+
- [TEAM NAME](src/<TEAM_NAME>/README.md)
58+
<!-- or -->
59+
- [TEAM NAME](src/<TEAM_NAME>.md)
60+
```
61+
62+
If you run `mdbook build`, `mdbook` will automatically create the folder and file for your team.
63+
64+
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 such be made as a subpage.
65+
66+
```markdown
67+
- [TOPIC](src/<TEAM_NAME>/TOPIC.md)
68+
```

0 commit comments

Comments
 (0)