diff --git a/doc/api/config.md b/doc/api/config.md index 4bab8cad324..ed994326201 100644 --- a/doc/api/config.md +++ b/doc/api/config.md @@ -70,7 +70,7 @@ Default: None | Type: Callable ### `autoreload` -Whether to autoreload server when script changes. +Whether to autoreload the page whenever the script or one of its dependencies changes. Default: False | Type: Boolean diff --git a/doc/getting_started/core_concepts.md b/doc/getting_started/core_concepts.md index e6f7140d671..325a614bbad 100644 --- a/doc/getting_started/core_concepts.md +++ b/doc/getting_started/core_concepts.md @@ -41,6 +41,10 @@ Once you run that command Panel will launch a server that will serve your app, o +```{note} +We recommend installing `watchfiles`, which will provide a significantly better user experience when using `--autoreload`. +``` + > Checkout [How-to > Prepare to develop](../how_to/prepare_to_develop.md) for more guidance on each of the development environment options. ## Control flow diff --git a/doc/how_to/server/commandline.md b/doc/how_to/server/commandline.md index 5b6666aa105..1b73cab8436 100644 --- a/doc/how_to/server/commandline.md +++ b/doc/how_to/server/commandline.md @@ -14,8 +14,11 @@ or even serve a number of apps at once: For development it can be particularly helpful to use the ``--autoreload`` option to `panel serve` as that will automatically reload the page whenever the application code or any of its imports change. -The ``panel serve`` command has the following options: +```{note} +We recommend installing `watchfiles`, which will provide a significantly better user experience when using `--autoreload`. +``` +The ``panel serve`` command has the following options: ``` console positional arguments: