Skip to content

Commit 7553e1e

Browse files
committed
CONTRIBUTING: Mention redirects.
1 parent 692bade commit 7553e1e

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,16 @@ add its domain to the exclude list in `book.toml`, under the
212212
`mdbook-linkcheck` is used by the void-docs repository's `check.sh` script,
213213
which must be [run locally before submitting a pull request](#making-changes).
214214

215+
#### Redirects
216+
217+
When changing a section name, or moving a section to a different part of the
218+
Handbook, a redirect must be added to the `[output.html.redirect]` section in
219+
`book.toml`, e.g.
220+
221+
```
222+
"/example.html" = "/new-location/example.html"
223+
```
224+
215225
### Case
216226

217227
Proper nouns outside of code blocks should use the casing of official

0 commit comments

Comments
 (0)