Skip to content

Commit

Permalink
odpi#116 update dirtyreload tips from review comments
Browse files Browse the repository at this point in the history
Signed-off-by: Nigel Jones <nigel.l.jones+git@gmail.com>
  • Loading branch information
planetf1 committed Nov 12, 2021
1 parent 2dccac5 commit d02806c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion site/docs/guides/documentation/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down

0 comments on commit d02806c

Please sign in to comment.