Skip to content

Commit ea7ee3a

Browse files
followerJoshua Nelson
authored and
Joshua Nelson
committed
Add link from "Writing Documentation" suggestion
A link to the relevant section of the contributing documentation makes it easier for contributors to locate the relevant information. (e.g. via an in-page search for "doc".) This is particularly important currently as https://github.com/rust-lang/rust/blob/85072e330394440776ace5ae612e3ced32ef6348/CONTRIBUTING.md links directly to the (currently `rustc`-focused) "Getting Started" guide rather than the general Rust contribution content to which it used to point.
1 parent c320337 commit ea7ee3a

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/getting-started.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -353,13 +353,14 @@ incredibly helpful:
353353
- [Cleanup crew][iceb]: find minimal reproductions of ICEs, bisect
354354
regressions, etc. This is a way of helping that saves a ton of time for
355355
others to fix an error later.
356-
- Writing documentation: if you are feeling a bit more intrepid, you could try
356+
- [Writing documentation][wd]: if you are feeling a bit more intrepid, you could try
357357
to read a part of the code and write doc comments for it. This will help you
358358
to learn some part of the compiler while also producing a useful artifact!
359359
- [Working groups][wg]: there are a bunch of working groups on a wide variety
360360
of rust-related things.
361361

362362
[iceb]: ./notification-groups/cleanup-crew.md
363+
[wd]: ./contributing.md#writing-documentation
363364
[wg]: https://rust-lang.github.io/compiler-team/working-groups/
364365

365366

0 commit comments

Comments
 (0)