diff options
| author | Mark Mansi <markm@cs.wisc.edu> | 2019-01-22 15:02:36 -0600 |
|---|---|---|
| committer | Who? Me?! <mark-i-m@users.noreply.github.com> | 2019-01-27 19:58:43 -0600 |
| commit | 49fb0c34d921eb7705dbdecd33cbf8c0e63102d5 (patch) | |
| tree | 95a0ce3cf86864bbc31a238ca1138e7d9d35bf0d /src/doc/rustc-dev-guide | |
| parent | 60e5886f82b40a2e8e315c7ccb5d719ee0dfa482 (diff) | |
| download | rust-49fb0c34d921eb7705dbdecd33cbf8c0e63102d5.tar.gz rust-49fb0c34d921eb7705dbdecd33cbf8c0e63102d5.zip | |
fix updating-docs link, add regression test
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/SUMMARY.md | 1 | ||||
| -rw-r--r-- | src/doc/rustc-dev-guide/src/important-links.md | 12 | ||||
| -rw-r--r-- | src/doc/rustc-dev-guide/src/stabilization_guide.md | 2 |
3 files changed, 15 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/SUMMARY.md b/src/doc/rustc-dev-guide/src/SUMMARY.md index 4df03dc7aec..2d8c1702415 100644 --- a/src/doc/rustc-dev-guide/src/SUMMARY.md +++ b/src/doc/rustc-dev-guide/src/SUMMARY.md @@ -82,3 +82,4 @@ [Appendix B: Background material](./appendix/background.md) [Appendix C: Glossary](./appendix/glossary.md) [Appendix D: Code Index](./appendix/code-index.md) +[](./important-links.md) diff --git a/src/doc/rustc-dev-guide/src/important-links.md b/src/doc/rustc-dev-guide/src/important-links.md new file mode 100644 index 00000000000..2dc759bf63c --- /dev/null +++ b/src/doc/rustc-dev-guide/src/important-links.md @@ -0,0 +1,12 @@ +# Ignore me + +This file is a collection of links that are not link-checked by anyone else, +but we want them to work. For example, the stabilization guide link is often +posted to tracking issues on GitHub, which might break later if the guide is +changed. + +[Skip this file. Or read it; I'm book, not a cop.](https://imgur.com/gallery/mSHi8) + +[1](https://forge.rust-lang.org/stabilization-guide.html) +[2](https://rust-lang.github.io/rustc-guide/stabilization_guide.html#documentation-prs) +[3](https://forge.rust-lang.org/stabilization-guide.html#updating-documentation) diff --git a/src/doc/rustc-dev-guide/src/stabilization_guide.md b/src/doc/rustc-dev-guide/src/stabilization_guide.md index ab5340c95dc..56da5cdaf16 100644 --- a/src/doc/rustc-dev-guide/src/stabilization_guide.md +++ b/src/doc/rustc-dev-guide/src/stabilization_guide.md @@ -11,6 +11,8 @@ following steps. ## Documentation PRs +<a name="updating-documentation"></a> + If any documentation for this feature exists, it should be in the [`Unstable Book`], located at [`src/doc/unstable-book`]. If it exists, the page for the feature gate should be removed. |