diff --git a/docs/apps/4_app_configuration_settings/4_app_styling.mdx b/docs/apps/4_app_configuration_settings/4_app_styling.mdx
index 39b528fa0..51281838d 100644
--- a/docs/apps/4_app_configuration_settings/4_app_styling.mdx
+++ b/docs/apps/4_app_configuration_settings/4_app_styling.mdx
@@ -67,7 +67,7 @@ The Global CSS Editor is a feature exclusive to [Enterprise Edition](../../misc/
Styling on a component level can be replicated to all the components of the same class from the Rich Editor.
-Just click on `Copy style to global CSS`.
+Just click on `Convert to global CSS`.
To do a fair comparison, looking at the quickstart is a great way to see the different orientation of the product.
-The [Airflow quickstart](https://airflow.apache.org/docs/apache-airflow/stable/tutorial/fundamentals.html#example-pipeline-definition) is a great starting point. One has to learn what is an Airflow pipeline before being able to create or edit them. They also do not provide a great way to debug locally and iterate on those pipelines. You have to write them, deploy them, and then test them. By comparison, in Windmill you can [write scripts locally](../advanced/4_local_development/index.mdx), or test them either step by step or the full flow in the [web UI](../core_concepts/6_auto_generated_uis/index.md).
+The [Airflow quickstart](https://airflow.apache.org/docs/apache-airflow/stable/tutorial/fundamentals.html#example-pipeline-definition) is a great starting point. One has to learn what is an Airflow pipeline before being able to create or edit them. They also do not provide a great way to debug locally and iterate on those pipelines. You have to write them, deploy them, and then test them. By comparison, in Windmill you can [write scripts locally](../advanced/4_local_development/index.mdx), or test them either step by step or the full flow in the [web UI](../core_concepts/6_auto_generated_uis/index.mdx).
diff --git a/docs/compared_to/prefect.mdx b/docs/compared_to/prefect.mdx
index b6d368296..294e0dfcb 100644
--- a/docs/compared_to/prefect.mdx
+++ b/docs/compared_to/prefect.mdx
@@ -94,7 +94,7 @@ The structuring of the flow and the configurations for each step are defined fro
-In particular, Windmill [generates automatically UIs](../core_concepts/6_auto_generated_uis/index.md) for flows and steps and lets users [test](../core_concepts/23_instant_preview/index.mdx) flows, steps or flow until a given step, from the UI.
+In particular, Windmill [generates automatically UIs](../core_concepts/6_auto_generated_uis/index.mdx) for flows and steps and lets users [test](../core_concepts/23_instant_preview/index.mdx) flows, steps or flow until a given step, from the UI.
Flows can be [defined visually / YAML](../advanced/4_local_development/index.mdx) on a local environment. Windmill will soon unveil an extension to facilitate the editing of flows in local development.
diff --git a/docs/compared_to/retool.mdx b/docs/compared_to/retool.mdx
index 2613e66b1..5a07335eb 100644
--- a/docs/compared_to/retool.mdx
+++ b/docs/compared_to/retool.mdx
@@ -83,7 +83,7 @@ For each of those languages, scripts can be run [without having to deal with sep
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.
+executable through [autogenerated UIs](../core_concepts/6_auto_generated_uis/index.mdx), [webhooks](../core_concepts/4_webhooks/index.md), etc.
-You can enable caching for a script directly in the script metadata. Here's how you can do it:
+You can enable caching for a script directly in the script Settings. Here's how you can do it:
-1. **Metadata**: From the Script Editor, pick the "Metdata" menu an scroll to "Cache".
+1. **Settings**: From the Script Editor, pick the "Settings" menu an scroll to "Cache".
2. **Enable Caching**: To enable caching, toggle on "Cache the results for each possible inputs" and specify the desired duration for caching results (in seconds.)
diff --git a/docs/core_concepts/25_dedicated_workers/index.mdx b/docs/core_concepts/25_dedicated_workers/index.mdx
index 3bae66402..4c6834143 100644
--- a/docs/core_concepts/25_dedicated_workers/index.mdx
+++ b/docs/core_concepts/25_dedicated_workers/index.mdx
@@ -19,7 +19,7 @@ To use:
The worker group will restart (assuming the pods/restart are set to restart automatically) and will now wait for step 2. below to happen:
-2. toggle the "Dedicated Workers" option for that script in the metadata:
+2. toggle the "Dedicated Workers" option for that script in the Settings:
![Dedicated Workers](./dedicated_workers.png)
diff --git a/docs/core_concepts/6_auto_generated_uis/index.md b/docs/core_concepts/6_auto_generated_uis/index.mdx
similarity index 66%
rename from docs/core_concepts/6_auto_generated_uis/index.md
rename to docs/core_concepts/6_auto_generated_uis/index.mdx
index 0eedab733..330c59925 100644
--- a/docs/core_concepts/6_auto_generated_uis/index.md
+++ b/docs/core_concepts/6_auto_generated_uis/index.mdx
@@ -1,3 +1,5 @@
+import DocCard from '@site/src/components/DocCard';
+
# Auto-Generated UIs
Windmill automatically generates user interfaces (UIs) for scripts and flows based on their parameters.
@@ -18,25 +20,25 @@ You might also be interested by Windmill's [App editor](../../getting_started/7_
:::
-## Details Page
-
By analyzing the parameters of the main function, Windmill generates an input specification for the script or flow in the [JSON Schema](../13_json_schema_and_parsing/index.md) format. Windmill then renders the UI for the Script or Flow from that specification.
You don't need to directly interact with the JSON Schema associated with the Script or Flow. It is the result of the analysis of the script parameters of the main function and the optional UI customization.
-In the UI customization interface, you can refine information that couldn't be inferred directly from the parameters, such as specifying string enums or restricting lists to numbers. You can also add helpful descriptions to each field.
+In the [UI customization interface](../../script_editor/customize_ui.mdx), you can refine information that couldn't be inferred directly from the parameters, such as specifying string enums or restricting lists to numbers. You can also add helpful descriptions to each field.
![Customize inputs](./customize_inputs.png.webp)
-> The inputs' positions and properties can be customized
-
-
-
-:::tip Test code
+
+
+
-This feature can be directly used in the [script](../../getting_started/0_scripts_quickstart/index.mdx) & [flow](../../getting_started/6_flows_quickstart/index.mdx) editors to test your code.
+## Test code
-
+This feature can be directly used in the [script](../../getting_started/0_scripts_quickstart/index.mdx) & [flow](../../getting_started/6_flows_quickstart/index.mdx) editors to [test your code](../23_instant_preview/index.mdx).
-:::
+
-## Automatically Generated Apps
+
+
+
+
+## Build App
You can generate a dedicated [app](../../apps/0_app_editor/index.mdx) to execute your script or flow.
@@ -68,4 +78,12 @@ The apps will be permissioned on behalf of the [admin/author](../16_roles_and_pe
-At last, this is an easy way to get an app for your scripts and flows to be customized with [Styling](../../apps/4_app_configuration_settings/4_app_styling.mdx) and [Components](../../apps/4_app_configuration_settings/1_app_component_library.mdx).
\ No newline at end of file
+At last, this is an easy way to get an app for your scripts and flows to be customized with [Styling](../../apps/4_app_configuration_settings/4_app_styling.mdx) and [Components](../../apps/4_app_configuration_settings/1_app_component_library.mdx).
+
+
+
+
\ No newline at end of file
diff --git a/docs/core_concepts/9_worker_groups/index.mdx b/docs/core_concepts/9_worker_groups/index.mdx
index 202632f2a..b99f9eb7f 100644
--- a/docs/core_concepts/9_worker_groups/index.mdx
+++ b/docs/core_concepts/9_worker_groups/index.mdx
@@ -72,7 +72,7 @@ WORKER_TAGS=tag1,tag2
## How to assign a custom worker group to a script or flow
-For scripts saved on the script editor, select the corresponding worker group tag in the metadata section.
+For scripts saved on the script editor, select the corresponding worker group tag in the settings section.
![Worker group tag](./select_script_builder.png.webp)
diff --git a/docs/core_concepts/index.mdx b/docs/core_concepts/index.mdx
index 5f06fcb10..776479326 100644
--- a/docs/core_concepts/index.mdx
+++ b/docs/core_concepts/index.mdx
@@ -179,9 +179,9 @@ All details on Scripts can be found in the [Script section](../script_editor/ind
href="/docs/script_editor/script_kinds"
/>
diff --git a/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/create_script_deno.png b/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/create_script_deno.png
index a811e0106..1cd9c0d37 100644
Binary files a/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/create_script_deno.png and b/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/create_script_deno.png differ
diff --git a/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/customize_ts.png b/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/customize_ts.png
index 4ee58e6f9..a87b66f5f 100644
Binary files a/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/customize_ts.png and b/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/customize_ts.png differ
diff --git a/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/customize_ts.png.avif b/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/customize_ts.png.avif
deleted file mode 100644
index decf2c179..000000000
Binary files a/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/customize_ts.png.avif and /dev/null differ
diff --git a/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/customize_ts.png.webp b/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/customize_ts.png.webp
deleted file mode 100644
index dc73fc6f2..000000000
Binary files a/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/customize_ts.png.webp and /dev/null differ
diff --git a/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/index.mdx b/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/index.mdx
index 26f6fc2c9..75a70cb1e 100644
--- a/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/index.mdx
+++ b/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/index.mdx
@@ -37,7 +37,7 @@ Scripts are the basic building blocks in Windmill. They can be [run and schedule
Scripts consist of 2 parts:
- [Code](#code): for TypeScript scripts, it must have at least a main function.
-- [Metadata](#metadata): metadata about the Script such as its path, summary, description, [jsonschema](../../../core_concepts/13_json_schema_and_parsing/index.md) of its inputs (inferred from its signature).
+- [Settings](#settings): settings & metadata about the Script such as its path, summary, description, [jsonschema](../../../core_concepts/13_json_schema_and_parsing/index.md) of its inputs (inferred from its signature).
When stored in a code repository, those 2 parts are stored separately at `
.ts` and `.script.yaml`.
@@ -63,11 +63,11 @@ In this quick start guide, we'll create a script that greets the operator runnin
From the Home page, click `+Script`. This will take you to the
first step of script creation: Metadata.
-## Metadata
+## Settings
![New script](./create_script_deno.png)
-Each script has metadata associated with it, enabling it to be defined and configured in depth.
+As part of the settings menu, each script has metadata associated with it, enabling it to be defined and configured in depth.
- **Path** is the Script's unique identifier that consist of the
[script's owner](../../../core_concepts/16_roles_and_permissions/index.mdx), and the script's name.
@@ -76,16 +76,22 @@ Each script has metadata associated with it, enabling it to be defined and confi
will be displayed as a title across Windmill. If omitted, the UI will use the `path` by
default.
- **Language** of the script.
-- **Description** is where you can give instructions through the [auto-generated UI](../../../core_concepts/6_auto_generated_uis/index.md)
+- **Description** is where you can give instructions through the [auto-generated UI](../../../core_concepts/6_auto_generated_uis/index.mdx)
to users on how to run your Script. It supports markdown.
+- **Script kind**: Action (by default), [Trigger](../../../flows/10_flow_trigger.md), [Approval](../../../flows/11_flow_approval.mdx) or [Error Handler](../../../flows/7_flow_error_handler.md). This acts as a tag to filter appropriate scripts from the [flow editor](../../6_flows_quickstart/index.mdx).
+
+This menu also has additional settings, such as:
+
- **[Concurrency limits](../../../script_editor/concurrency_limit.mdx)** enable defining concurrency limits for scripts and inline scripts within flows to prevent exceeding the API Limit of the targeted API.
- **[Worker group tag](../../../core_concepts/9_worker_groups/index.mdx)** to assign scripts to specific worker groups (such as nodes with GPU accelaration).
+- **[Cache](../../../core_concepts/24_caching/index.md)** to cache the results for each possible inputs for a given time.
+- **[Dedicated Workers](../../../core_concepts/25_dedicated_workers/index.mdx)** to run the script on, to run the script at native speed. Only available on enterprise edition and for the Bun language.
@@ -94,7 +100,7 @@ Now click on the code editor on the left side.
## Code
Windmill provides an online editor to work on your Scripts. The left-side is
-the editor itself. The right-side [previews the UI](../../../core_concepts/6_auto_generated_uis/index.md) that Windmill will
+the editor itself. The right-side [previews the UI](../../../core_concepts/6_auto_generated_uis/index.mdx) that Windmill will
generate from the Script's signature - this will be visible to the users of the
Script. You can easily preview that UI, provide input values, and [test your script](#instant-preview--testing) there.
@@ -149,7 +155,7 @@ entrypoint. There are a few important things to note about the `main`.
- The main arguments are used for generating
1. the [input spec](../../../core_concepts/13_json_schema_and_parsing/index.md) of the Script
- 2. the [frontend](../../../core_concepts/6_auto_generated_uis/index.md) that you see when running the Script as a standalone app.
+ 2. the [frontend](../../../core_concepts/6_auto_generated_uis/index.mdx) that you see when running the Script as a standalone app.
- Type annotations are used to generate the UI form, and help pre-validate
inputs. While not mandatory, they are highly recommended. You can customize
the UI in later steps (but not change the input type!).
@@ -224,7 +230,7 @@ entrypoint. There are a few important things to note about the `main`.
- The main arguments are used for generating
1. the [input spec](../../../core_concepts/13_json_schema_and_parsing/index.md) of the Script
- 2. the [frontend](../../../core_concepts/6_auto_generated_uis/index.md) that you see when running the Script as a standalone app.
+ 2. the [frontend](../../../core_concepts/6_auto_generated_uis/index.mdx) that you see when running the Script as a standalone app.
- Type annotations are used to generate the UI form, and help pre-validate
inputs. While not mandatory, they are highly recommended. You can customize
the UI in later steps (but not change the input type!).
@@ -298,19 +304,15 @@ main(name: string = "you")
/>
-Now let's go to the last step: the "Customise" settings.
+Now let's go to the last step: the "Generated UI" settings.
-## Customize Settings
+## Customize UI
-In this menu, you can:
+From the Settings menu, the "Generated UI" tab lets you customize the script's arguments.
-- Give a **script kind**: Action (by default), [Trigger](../../../flows/10_flow_trigger.md), [Approval](../../../flows/11_flow_approval.mdx) or [Error Handler](../../../flows/7_flow_error_handler.md). This acts as a tag to filter appropriate scripts from the [flow editor](../../6_flows_quickstart/index.mdx).
-- Customize the script's **Arguments**. The UI is generated from the Script's main function signature, but you can add additional constraints here. For example, we could use the `Customize property`: add a regex by clicking on `Pattern` to make sure users are providing a name with only alphanumeric characters: `^[A-Za-z0-9]+$`. Let's still allow numbers in case you are some tech billionaire's kid.
+The UI is generated from the Script's main function signature, but you can add additional constraints here. For example, we could use the `Customize property`: add a regex by clicking on `Pattern` to make sure users are providing a name with only alphanumeric characters: `^[A-Za-z0-9]+$`. Let's still allow numbers in case you are some tech billionaire's kid.
-![Advanced settings for TypeScript](./customize_ts.png.webp)
-
-We're done! Save your script. Note that Scripts are versioned in Windmill, and
-each script version is uniquely identified by a hash.
+![Advanced settings for TypeScript](./customize_ts.png)