From 10601e1c174fbb9948cf19e6e52a93ca0839bbd3 Mon Sep 17 00:00:00 2001 From: follower Date: Sun, 27 Sep 2020 04:08:41 +1300 Subject: [PATCH] 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. --- src/getting-started.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/getting-started.md b/src/getting-started.md index 9c67f3dc4..75838060c 100644 --- a/src/getting-started.md +++ b/src/getting-started.md @@ -353,13 +353,14 @@ incredibly helpful: - [Cleanup crew][iceb]: find minimal reproductions of ICEs, bisect regressions, etc. This is a way of helping that saves a ton of time for others to fix an error later. -- Writing documentation: if you are feeling a bit more intrepid, you could try +- [Writing documentation][wd]: if you are feeling a bit more intrepid, you could try to read a part of the code and write doc comments for it. This will help you to learn some part of the compiler while also producing a useful artifact! - [Working groups][wg]: there are a bunch of working groups on a wide variety of rust-related things. [iceb]: ./notification-groups/cleanup-crew.md +[wd]: ./contributing.md#writing-documentation [wg]: https://rust-lang.github.io/compiler-team/working-groups/