diff --git a/docs/advanced/7_docker/as_flow.png b/docs/advanced/7_docker/as_flow.png
index 1d641264c..4af003af7 100644
Binary files a/docs/advanced/7_docker/as_flow.png and b/docs/advanced/7_docker/as_flow.png differ
diff --git a/docs/advanced/7_docker/as_flow.png.avif b/docs/advanced/7_docker/as_flow.png.avif
deleted file mode 100644
index c18b5bf31..000000000
Binary files a/docs/advanced/7_docker/as_flow.png.avif and /dev/null differ
diff --git a/docs/advanced/7_docker/as_flow.png.webp b/docs/advanced/7_docker/as_flow.png.webp
deleted file mode 100644
index cac3b0bb5..000000000
Binary files a/docs/advanced/7_docker/as_flow.png.webp and /dev/null differ
diff --git a/docs/advanced/7_docker/as_flow2.png b/docs/advanced/7_docker/as_flow2.png
index 9059788e9..4b3d86533 100644
Binary files a/docs/advanced/7_docker/as_flow2.png and b/docs/advanced/7_docker/as_flow2.png differ
diff --git a/docs/advanced/7_docker/as_flow2.png.avif b/docs/advanced/7_docker/as_flow2.png.avif
deleted file mode 100644
index 8bb6277d6..000000000
Binary files a/docs/advanced/7_docker/as_flow2.png.avif and /dev/null differ
diff --git a/docs/advanced/7_docker/as_flow2.png.webp b/docs/advanced/7_docker/as_flow2.png.webp
deleted file mode 100644
index fc7cae0d7..000000000
Binary files a/docs/advanced/7_docker/as_flow2.png.webp and /dev/null differ
diff --git a/docs/advanced/7_docker/as_script.png b/docs/advanced/7_docker/as_script.png
index f9f35395c..8182c2b17 100644
Binary files a/docs/advanced/7_docker/as_script.png and b/docs/advanced/7_docker/as_script.png differ
diff --git a/docs/advanced/7_docker/as_script.png.avif b/docs/advanced/7_docker/as_script.png.avif
deleted file mode 100644
index 6eab4d838..000000000
Binary files a/docs/advanced/7_docker/as_script.png.avif and /dev/null differ
diff --git a/docs/advanced/7_docker/as_script.png.webp b/docs/advanced/7_docker/as_script.png.webp
deleted file mode 100644
index c2757ae37..000000000
Binary files a/docs/advanced/7_docker/as_script.png.webp and /dev/null differ
diff --git a/docs/advanced/7_docker/as_script2.png b/docs/advanced/7_docker/as_script2.png
index 58c5e657a..a41f9e373 100644
Binary files a/docs/advanced/7_docker/as_script2.png and b/docs/advanced/7_docker/as_script2.png differ
diff --git a/docs/advanced/7_docker/as_script2.png.avif b/docs/advanced/7_docker/as_script2.png.avif
deleted file mode 100644
index 6ff8e3bf3..000000000
Binary files a/docs/advanced/7_docker/as_script2.png.avif and /dev/null differ
diff --git a/docs/advanced/7_docker/as_script2.png.webp b/docs/advanced/7_docker/as_script2.png.webp
deleted file mode 100644
index 1870db95a..000000000
Binary files a/docs/advanced/7_docker/as_script2.png.webp and /dev/null differ
diff --git a/docs/advanced/7_docker/index.md b/docs/advanced/7_docker/index.mdx
similarity index 78%
rename from docs/advanced/7_docker/index.md
rename to docs/advanced/7_docker/index.mdx
index a33e0ba87..a80b7ec7b 100644
--- a/docs/advanced/7_docker/index.md
+++ b/docs/advanced/7_docker/index.mdx
@@ -1,12 +1,24 @@
+import DocCard from '@site/src/components/DocCard';
+
# Run Docker Containers
-Windmill support running any docker container through its bash support. As a pre-requisite, the host docker daemon need to be mounted into the worker container. This is done through a simple volume mount: `/var/run/docker.sock:/var/run/docker.sock`.
+Windmill supports running any [Docker](https://www.docker.com/) container through its [Bash](../../getting_started/0_scripts_quickstart/4_bash_quickstart/index.mdx) support. As a pre-requisite, the host docker daemon needs to be mounted into the worker container. This is done through a simple volume mount: `/var/run/docker.sock:/var/run/docker.sock`.
+
+Once Docker is set up, see:
+
+
+
+
## Setup
### Docker compose
-On the docker-compose, it is enough to uncomment the volume mount of the windmill worker
+On the docker-compose, it is enough to uncomment the volume mount of the Windmill worker
```dockerfile
# mount the docker socket to allow to run docker containers from within the workers
@@ -15,7 +27,7 @@ On the docker-compose, it is enough to uncomment the volume mount of the windmil
### Helm charts
-In the charts values of our [helm charts](https://github.com/windmill-labs/windmill-helm-charts), set `windmill.exposeHostDocker` to `true`
+In the charts values of our [helm charts](https://github.com/windmill-labs/windmill-helm-charts), set `windmill.exposeHostDocker` to `true`.
### Remote Docker Daemon
@@ -39,7 +51,6 @@ spec:
privileged: true
```
-
## Use
The default code is as follows:
@@ -70,15 +81,15 @@ Like any bash script, it will return the last line of the stdout. So be sure to
As a script:
-![script 1](./as_script.png.webp)
+![script 1](./as_script.png)
-![script 2](./as_script2.png.webp)
+![script 2](./as_script2.png)
As a flow step:
-![flow step 1](./as_flow.png.webp)
+![flow step 1](./as_flow.png)
-![flow step 2](./as_flow2.png.webp)
+![flow step 2](./as_flow2.png)
## Use with Remote Docker Daemon
diff --git a/docs/advanced/index.md b/docs/advanced/index.md
index a78661c3a..a9b07f3f6 100644
--- a/docs/advanced/index.md
+++ b/docs/advanced/index.md
@@ -14,6 +14,6 @@ Windmill's most advanced guides.
Run Docker Containers
- Windmill support running any docker container through its bash support.
+ Windmill supports running any docker container through its Bash support.
diff --git a/docs/apps/0_app_editor/index.mdx b/docs/apps/0_app_editor/index.mdx
index d4ea42b64..2ecb06f68 100644
--- a/docs/apps/0_app_editor/index.mdx
+++ b/docs/apps/0_app_editor/index.mdx
@@ -21,13 +21,14 @@ The app editor is a low-code builder to create apps with components, create inte
-The app editor is composed of 5 main sections:
+The app editor is composed of 6 main sections:
1. [Toolbar](/docs/apps/app_editor#toolbar)
2. [Canvas](#canvas)
3. [Outputs](#outputs)
4. [Runnables panel](#runnables-panel)
5. [Component Library and Settings](#component-library-and-settings)
+6. [App Styling]
![App Editor](../../assets/apps/0_app_editor/plain-app-editor.png.webp)
@@ -35,7 +36,7 @@ The app editor is composed of 5 main sections:
The topbar helps you in your app editing.
-![App Menu](../../assets/apps/1_app_toolbar/app-toolbar.png.webp)
+![App Menu](../../assets/apps/1_app_toolbar/app-toolbar.png)
#### Learn more
@@ -79,7 +80,7 @@ The canvas at the center of the editor is where you design and see the overall U
## Outputs
-On the left panel of the editor, you can see the list of outputs of the app. These outputs represent the state of the app and are categorized into four types:
+On the left panel of the editor, you can see the list of outputs of the app. These outputs represent the states & results of the app and are categorized into four types:
- **Context**: The context holds information such as the user email, username, workspace, query parameters, and more.
- **State**: The state holds the app's current state, which can be manipulated by the frontend scripts.
@@ -100,8 +101,8 @@ You can perform the following actions with the outputs:
+
+
+## Styling
+
+Styling on the app editor can be managed at the component and app-level, with pre-set configurations or using CSS & [Tailwind](https://tailwindcss.com/).
+
+#### Learn more
+
+
+
+
+
+## Other app features
+
+
-
+
\ No newline at end of file
diff --git a/docs/apps/0_toolbar.md b/docs/apps/0_toolbar.md
index de5bba2d9..d5fd397c3 100644
--- a/docs/apps/0_toolbar.md
+++ b/docs/apps/0_toolbar.md
@@ -1,21 +1,8 @@
# Toolbar Guide
-The app toolbar is located at the top of the app editor. It enables you to adjust app settings, toggle between desktop/mobile preview, and debug runs.
-
-![App Menu](../assets/apps/1_app_toolbar/app-toolbar.png.webp)
-
-- [App Summary](#app-summary): The summary is the name that will be displayed for your app.
-- [Undo/Redo](#app-summary): Perform undo or redo actions.
-- [Desktop/Mobile Mode](#desktopmobile-mode): Switch between Mobile and Desktop layout.
-- [Width](#width): Switch between full and max width.
-- [Deployement history](#deployement-history): View the deployment history of the app.
-- [JSON](#json): Export your app as a JSON or [Hub](https://hub.windmill.dev/) compatible file.
-- [Hub compatible JSON](#hub-compatible-json): View the JSON representation of the app in a format that is compatible with the [Windmill Hub](https://hub.windmill.dev/).
-- [App Inputs Configuration](#app-inputs-configuration): the app inputs menu displays a list of all the inputs of each component.
-- [Debugging](#debug-runs): Open the debugging panel.
-- [Editor/Preview Mode](#preview-mode): Toggle between the Editor and Preview modes.
-- [Save as Draft](#save-as-draft): Save your app as a [draft](../core_concepts/0_draft_and_deploy/index.mdx#draft).
-- [Deploy](#deploy): [Deploy](../core_concepts/0_draft_and_deploy/index.mdx#deployed-version) your app.
+The app toolbar is located at the top of the app editor. It enables you to adjust app settings.
+
+![App Menu](../assets/apps/1_app_toolbar/app-toolbar.png)
## App Summary
@@ -41,19 +28,19 @@ The `⋮` menu provides access to the following options:
### Deployement history
-In the menu, you can view the deployment history of the app. It displays the date and time of the deployment, the user who deployed the app, and the version of the app.
+In the menu, you can view the [deployment](./6_app_deployment.mdx) history of the app. It displays the date and time of the deployment, the user who deployed the app, and the version of the app.
You can:
- View the app at a specific version.
-- Restore a fork
-- Restore here
+- Restore a fork.
+- Restore here.
![Deployement history](../assets/apps/1_app_toolbar/deployement-history.png.webp)
### JSON
-View the JSON representation of the app.
+View the [JSON representation](../core_concepts/13_json_schema_and_parsing/index.md) of the app.
### Hub compatible JSON
@@ -67,7 +54,7 @@ The app inputs menu displays a list of all the inputs of each component. A toggl
## Debug Runs
-The app builder enables you to examine recent runs to identify potential bugs.
+The app builder enables you to examine recent runs to [identify potential bugs](./5_app_debugging.md).
![App Debug Runs](../assets/apps/1_app_toolbar/app-debug-runs.png.webp)
@@ -77,13 +64,12 @@ The app editor mode can be toggled between `Editor` and `Preview` modes. The pre
## Save as draft
-You can [save](../core_concepts/0_draft_and_deploy/index.mdx) the app. The first time you save the app, you'll be asked to select the owner of the app. You can choose either a user or a [folder](../core_concepts/8_groups_and_folders/index.mdx#folders).
+You can [save](./6_app_deployment.mdx) the app. The first time you save the app, you'll be asked to select the owner of the app. You can choose either a user or a [folder](../core_concepts/8_groups_and_folders/index.mdx#folders).
## Deploy
-You can [deploy](../core_concepts/0_draft_and_deploy/index.mdx#deployed-version) the app as a standalone app via a URL. There are two ways to publish an app:
-
-- Read-Access Required: The app can be accessed by anyone who has read access to the app.
-- Publish Publicly: The app can be accessed by anyone who knows the secret URL. If set to `Publish Publicly`, the secret URL will be displayed here.
+Windmill apps are custom-made user interfaces meant to interact with scripts and flows.
-![App Publish](../assets/apps/1_app_toolbar/app-publish.png.webp)
\ No newline at end of file
+There are two ways to [deploy](./6_app_deployment.mdx) an app:
+- **Read-Access Required**: The app can be accessed & triggered by anyone who has [read access](../core_concepts/16_roles_and_permissions/index.mdx) to the app.
+- **Publish Publicly**: The app can be accessed as a standalone app by anyone who has the secret URL.
\ No newline at end of file
diff --git a/docs/apps/2_outputs.md b/docs/apps/2_outputs.md
index 16cccf258..ebf103ad2 100644
--- a/docs/apps/2_outputs.md
+++ b/docs/apps/2_outputs.md
@@ -1,6 +1,8 @@
# Outputs Guide
-On the left-hand side of the app editor, you can find the app outputs. They are three kind of outputs:
+The outputs represent the states & results of the app.
+
+All outputs can be found on the left-hand side of the app editor. There are three kind of outputs:
- Context and state
- Component outputs
diff --git a/docs/apps/6_app_deployment.mdx b/docs/apps/6_app_deployment.mdx
index b7f25f9b2..73fb45e74 100644
--- a/docs/apps/6_app_deployment.mdx
+++ b/docs/apps/6_app_deployment.mdx
@@ -2,16 +2,27 @@ import DocCard from '@site/src/components/DocCard';
# Deployment
-Apps can be saved as draft before being published.
+Windmill apps are custom-made user interfaces meant to interact with scripts and flows.
+
+There are two ways to [deploy](../core_concepts/0_draft_and_deploy/index.mdx) an app:
+- **Read-Access Required**: The app can be accessed & triggered by anyone who has [read access](../core_concepts/16_roles_and_permissions/index.mdx) to the app.
+- **Publish Publicly**: The app can be accessed as a standalone app by anyone who has the secret URL.
+
+Apps can be saved as [draft](../core_concepts/0_draft_and_deploy/index.mdx#draft) before being published.
### Learn more
-
+
diff --git a/docs/apps/8_public_apps.md b/docs/apps/8_public_apps.md
new file mode 100644
index 000000000..24c0a7651
--- /dev/null
+++ b/docs/apps/8_public_apps.md
@@ -0,0 +1,12 @@
+# Public Apps
+
+Windmill apps are custom-made user interfaces meant to interact with scripts and flows.
+
+There are two ways to [deploy](./6_app_deployment.mdx) an app:
+- **Read-Access Required**: The app can be accessed & triggered by anyone who has [read access](../core_concepts/16_roles_and_permissions/index.mdx) to the app.
+- **Publish Publicly**: The app can be accessed as a standalone app by anyone who has the secret URL.
+This feature requires saving the app at least to [draft](../core_concepts/0_draft_and_deploy/index.mdx#draft) before.
+
+![Read-Access App](../assets/apps/8_public_apps/read_only_app.png "Read-Access App")
+
+![Public App](../assets/apps/8_public_apps/public_app.png "Public App")
\ No newline at end of file
diff --git a/docs/assets/apps/1_app_toolbar/app-publish.png b/docs/assets/apps/1_app_toolbar/app-publish.png
deleted file mode 100644
index 3a773a23d..000000000
Binary files a/docs/assets/apps/1_app_toolbar/app-publish.png and /dev/null differ
diff --git a/docs/assets/apps/1_app_toolbar/app-publish.png.avif b/docs/assets/apps/1_app_toolbar/app-publish.png.avif
deleted file mode 100644
index 575e71223..000000000
Binary files a/docs/assets/apps/1_app_toolbar/app-publish.png.avif and /dev/null differ
diff --git a/docs/assets/apps/1_app_toolbar/app-publish.png.webp b/docs/assets/apps/1_app_toolbar/app-publish.png.webp
deleted file mode 100644
index fde9c81c4..000000000
Binary files a/docs/assets/apps/1_app_toolbar/app-publish.png.webp and /dev/null differ
diff --git a/docs/assets/apps/1_app_toolbar/app-toolbar.png b/docs/assets/apps/1_app_toolbar/app-toolbar.png
index e67bb1bc2..350ea1bd0 100644
Binary files a/docs/assets/apps/1_app_toolbar/app-toolbar.png and b/docs/assets/apps/1_app_toolbar/app-toolbar.png differ
diff --git a/docs/assets/apps/1_app_toolbar/app-toolbar.png.avif b/docs/assets/apps/1_app_toolbar/app-toolbar.png.avif
deleted file mode 100644
index 3f0102df3..000000000
Binary files a/docs/assets/apps/1_app_toolbar/app-toolbar.png.avif and /dev/null differ
diff --git a/docs/assets/apps/1_app_toolbar/app-toolbar.png.webp b/docs/assets/apps/1_app_toolbar/app-toolbar.png.webp
deleted file mode 100644
index c33d7ddfc..000000000
Binary files a/docs/assets/apps/1_app_toolbar/app-toolbar.png.webp and /dev/null differ
diff --git a/docs/assets/apps/8_public_apps/public_app.png b/docs/assets/apps/8_public_apps/public_app.png
new file mode 100644
index 000000000..ee0a0fb4e
Binary files /dev/null and b/docs/assets/apps/8_public_apps/public_app.png differ
diff --git a/docs/assets/apps/8_public_apps/read_only_app.png b/docs/assets/apps/8_public_apps/read_only_app.png
new file mode 100644
index 000000000..3fecd49e3
Binary files /dev/null and b/docs/assets/apps/8_public_apps/read_only_app.png differ
diff --git a/docs/compared_to/retool.mdx b/docs/compared_to/retool.mdx
index eaeb503c9..f30177aad 100644
--- a/docs/compared_to/retool.mdx
+++ b/docs/compared_to/retool.mdx
@@ -78,7 +78,7 @@ However, the possibilities with code on Retool will be much more limited:
Retool only supports JavaScript and SQL. Windmill supports JavaScript ([TypeScript](../getting_started/0_scripts_quickstart/1_typescript_quickstart/index.mdx)), [SQL](../getting_started/0_scripts_quickstart/5_sql_quickstart/index.mdx), but also [Python](../getting_started/0_scripts_quickstart/2_python_quickstart/index.mdx), [Go](../getting_started/0_scripts_quickstart/3_go_quickstart/index.mdx), [Bash](../getting_started/0_scripts_quickstart/4_bash_quickstart/index.mdx).
For each of those languages, scripts can be run [without having to deal with separate dependency files](../advanced/6_imports/index.md).
-For other languages, Windmill supports [running any docker container](../advanced/7_docker/index.md) through its bash support.
+For other languages, Windmill supports [running any docker container](../advanced/7_docker/index.mdx) through its bash support.
All operations in Windmill are based on scripts. Unlike Retool, scripts in Windmill can be considered as standalone endpoints:
executable through [autogenerated UIs](../core_concepts/6_auto_generated_uis/index.md), [webhooks](../core_concepts/4_webhooks/index.md), etc.
diff --git a/docs/core_concepts/0_draft_and_deploy/index.mdx b/docs/core_concepts/0_draft_and_deploy/index.mdx
index 5acdad624..100b68f7a 100644
--- a/docs/core_concepts/0_draft_and_deploy/index.mdx
+++ b/docs/core_concepts/0_draft_and_deploy/index.mdx
@@ -6,6 +6,8 @@ Draft, test, and deploy scripts, flows, and apps Windmill to iterate and save sa
Each script, flow or app can be saved (sometimes concurrently) in 3 fashions, by your browser in `local storage`, by the backend as a `draft`, and `deployed`.
+Once deployed, scripts, flows and apps will be visible, editable and/or runnable by users [with the right permissions](../16_roles_and_permissions/index.mdx).
+