Skip to content

Commit 52ad0b0

Browse files
committed
docs(dev-guide): mention that we need to keep mdBook links stable
1 parent 3e8e49b commit 52ad0b0

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

doc/dev-guide/src/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ We use `rustfmt` to keep our codebase consistently formatted. Please ensure that
3535
you have correctly formatted your code (most editors will do this automatically
3636
when saving) or it may not pass the CI tests.
3737

38+
If you are moving, renaming or removing an existing mdBook page, please use mdBook's
39+
[`output.html.redirect`] feature to ensure that the old URL gets redirected.
40+
41+
[`output.html.redirect`]: https://rust-lang.github.io/mdBook/format/configuration/renderers.html#outputhtmlredirect
42+
3843
Unless you explicitly state otherwise, any contribution intentionally
3944
submitted for inclusion in the work by you, as defined in the
4045
Apache-2.0 license, shall be dual licensed as in the README, without any

0 commit comments

Comments
 (0)