From 986d371cb01400e9bb9f8d9bc93aea09fd93b583 Mon Sep 17 00:00:00 2001 From: Mark Mansi Date: Tue, 22 Jan 2019 15:02:36 -0600 Subject: [PATCH] fix updating-docs link, add regression test --- src/SUMMARY.md | 1 + src/important-links.md | 12 ++++++++++++ src/stabilization_guide.md | 2 ++ 3 files changed, 15 insertions(+) create mode 100644 src/important-links.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 4df03dc7..2d8c1702 100644 --- a/src/SUMMARY.md +++ b/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/important-links.md b/src/important-links.md new file mode 100644 index 00000000..2dc759bf --- /dev/null +++ b/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/stabilization_guide.md b/src/stabilization_guide.md index ab5340c9..56da5cda 100644 --- a/src/stabilization_guide.md +++ b/src/stabilization_guide.md @@ -11,6 +11,8 @@ following steps. ## Documentation PRs + + 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.