diff --git a/docs_src/_static/draganddrop.gif b/docs_src/_static/draganddrop.gif new file mode 100644 index 0000000..aab3657 Binary files /dev/null and b/docs_src/_static/draganddrop.gif differ diff --git a/docs_src/_static/url.gif b/docs_src/_static/url.gif new file mode 100644 index 0000000..ea73331 Binary files /dev/null and b/docs_src/_static/url.gif differ diff --git a/docs_src/getting_started.md b/docs_src/getting_started.md index f0e91e3..8c2999c 100644 --- a/docs_src/getting_started.md +++ b/docs_src/getting_started.md @@ -58,7 +58,9 @@ The app has been successfully tested with Python versions equal or higher to 3.9 The application comes with examples stored in the `/yaml` folder which can be used in two ways: -- by uploading one `.yaml` file in the interface via drag and drop or -- by typing the `DashID` of the dashboard in the URL (i.e. [http://127.0.0.1:5000/eurostat](http://127.0.0.1:5000/eurostat) for the `eurostat_sample.yaml` file which contains `DashID: eurostat`). +- by uploading one `.yaml` file in the interface via drag and drop or
+ +- by typing the `DashID` of the dashboard in the URL (i.e. [http://127.0.0.1:5000/eurostat](http://127.0.0.1:5000/eurostat) for the `eurostat_sample.yaml` file which contains `DashID: eurostat`)
+ The application will scan the existing content in the `yaml` subfolder of the project and load the `.yaml` file containing the requested `DashID`. If none is found, the app will raise a `PreventUpdate`.