diff --git a/README.md b/README.md index 33d62d0..b431b6a 100644 --- a/README.md +++ b/README.md @@ -162,6 +162,11 @@ By default, this serves the docs on `http://localhost:8000`, but you can change this with `-a`/`--dev-addr`. Remember though, *this is for testing only*. To host your docs for real, you should use a real web server. +> [!NOTE] +> When editing your documentation, it's usually best to use `mkdocs serve` +> instead. This renders the current version of your documentation without +> forcing you to create a Git commit first via `mike deploy`. + ### Deleting Docs Sometimes you need to delete an old version of your docs, either because you