From d02806cc202f2ac718c8d49f26f6f6266c69e9cc Mon Sep 17 00:00:00 2001 From: Nigel Jones Date: Fri, 12 Nov 2021 08:58:31 +0000 Subject: [PATCH] #116 update dirtyreload tips from review comments Signed-off-by: Nigel Jones --- site/docs/guides/documentation/guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/docs/guides/documentation/guide.md b/site/docs/guides/documentation/guide.md index efb7e16b16..4f95160f25 100644 --- a/site/docs/guides/documentation/guide.md +++ b/site/docs/guides/documentation/guide.md @@ -36,7 +36,7 @@ When contributing to the documentation, you can easily use this to test document To speed this up to a second or two, use the `--dirtyreload` flag to `mkdocs serve`. Note that any deleted pages will not be removed, and some links may break as a result that would otherwise work with a full reload (i.e. navigation structure changes). - [Release notes](https://www.mkdocs.org/about/release-notes/#support-for-dirty-builds-990) for the feature have further information. + See [Release notes](https://www.mkdocs.org/about/release-notes/#support-for-dirty-builds-990) for further information. !!! warning "Special handling of index.md" Be aware that the specific theme we use will treat every `index.md` as an index page for a section: these behave in special ways depending on the level of the navigation in which they appear. Unless you mean to create an overview of some section of the navigation, do **not** name your Markdown file `index.md`.