Fixes on quickstarts (windmill-labs#283)

hcourdent · web-flow · commit ec145b9a3d42 · 2023-08-23T15:53:41.000+02:00
diff --git a/docs/core_concepts/1_scheduling/index.md b/docs/core_concepts/1_scheduling/index.md
@@ -150,7 +150,7 @@ From the metadata menu, change the owner to a [folder](../../core_concepts/8_gro
 
 <br/>
 
-Voilà, all done! The process is very simple but it will allow you to schedule tasks with confidence and get an aggregated view on them.
+The process is very simple but it will allow you to schedule tasks with confidence and get an aggregated view on them.
 
 Not only can you build scheduled jobs [from Windmill](../../getting_started/00_how_to_use_windmill/index.mdx) but also you can import all your existing scripts - as Windmill supports TypeScript, Python, Go, Bash or SQL - [as did one of our esteemed users](/blog/stantt-case-study) for their own scheduled jobs.
 
diff --git a/docs/core_concepts/4_webhooks/index.md b/docs/core_concepts/4_webhooks/index.md
@@ -103,7 +103,7 @@ securely!
 
 ## Webhook specific tokens
 
-Webhook specific tokens allow you to share without fear your tokens publicly since the token will only be able to trigger a specific script/flow and not impersonate you for any other operations.
+Webhook specific tokens allow sharing tokens  publicly without fear since the token will only be able to trigger a specific script/flow and not impersonate you for any other operations.
 
 It also avoids the hassle of having to create an anonymous user and check their permissions. If you can run the script yourself, then the webhook specific token will still inherit your own permissions.
 
diff --git a/docs/core_concepts/8_groups_and_folders/index.mdx b/docs/core_concepts/8_groups_and_folders/index.mdx
@@ -27,7 +27,7 @@ Similar to users, groups can be assigned one of three permission levels for a sp
 
 ## Folders
 
-Folders allow you to group various **items**, such as scripts, flows, resources, and schedules, together and assign Role-based access control permissions to groups and individual users.
+Folders group various **items**, such as scripts, flows, resources, and schedules, together and assign Role-based access control permissions to groups and individual users.
 
 ![Folders](./3-folders.png 'Folders')
 
diff --git a/docs/core_concepts/9_worker_groups/index.md b/docs/core_concepts/9_worker_groups/index.md
@@ -1,9 +1,7 @@
 # Workers and Worker Groups
 
-## Workers
-
 Workers are autonomous processes that run one script at a time using the full
-machines resources available to them.
+machines resources available to them. They are at the basis of [Windmill's architecture](../../misc/10_architecture/index.md).
 
 Workers pull [jobs](../20_jobs/index.md) from the queue of jobs in the order of their
 `scheduled_for` datetime as long as it is in the past. As soon as a worker pulls
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
@@ -19,7 +19,7 @@ In this quick start guide, we will write our first script in TypeScript. Windmil
 
 <br />
 
-Scripts are the basic building blocks in Windmill. They can be [run and scheduled](../../8_trigger_scripts/index.mdx) as standalone, chained together to create [Flows][flows] or displayed with a personalized User Interface as [Apps](../../7_apps_quickstart/index.mdx).
+Scripts are the basic building blocks in Windmill. They can be [run and scheduled](../../8_trigger_scripts/index.mdx) as standalone, chained together to create [Flows](../../../flows/1_flow_editor.mdx) or displayed with a personalized User Interface as [Apps](../../7_apps_quickstart/index.mdx).
 
 <div class="grid grid-cols-2 gap-6 mb-4">
 	<DocCard
@@ -76,10 +76,10 @@ 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**: this is where you can give instructions
-  to users on how to run your Script. It supports markdown!
-- **[Concurrency limits](../../../script_editor/concurrency_limit.mdx)**: it allows you to define 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.md)**, if you want to run some scripts on a GPU machine.
+- **Description** is where you can give instructions through the [auto-generated UI](../../../core_concepts/6_auto_generated_uis/index.md)
+  to users on how to run your Script. It supports markdown.
+- **[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.md)** to assign scripts to specific worker groups (such as nodes with GPU accelaration).
 
 <div class="grid grid-cols-2 gap-6 mb-4">
 	<DocCard
@@ -93,11 +93,10 @@ Now click on the code editor on the left side.
 
 ## Code
 
-Windmill gives you an online editor to work on your Scripts. The left-side is
-the editor itself. The right-side lets you [preview the UI](../../../core_concepts/6_auto_generated_uis/index.md) that Windmill will
+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
 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 there.
+Script. You can easily preview that UI, provide input values, and [test your script](#instant-preview--testing) there.
 
 ![Editor for Deno](./editor_deno.png)
 
diff --git a/docs/getting_started/0_scripts_quickstart/2_python_quickstart/index.mdx b/docs/getting_started/0_scripts_quickstart/2_python_quickstart/index.mdx
@@ -71,10 +71,10 @@ 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**: this is where you can give instructions
-  to users on how to run your Script. It supports markdown!
-- **[Concurrency limits](../../../script_editor/concurrency_limit.mdx)**: it allows you to define 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.md)**, if you want to run some scripts on a GPU machine.
+- **Description** is where you can give instructions through the [auto-generated UI](../../../core_concepts/6_auto_generated_uis/index.md)
+  to users on how to run your Script. It supports markdown.
+- **[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.md)** to assign scripts to specific worker groups (such as nodes with GPU accelaration).
 
 <div class="grid grid-cols-2 gap-6 mb-4">
 	<DocCard
@@ -88,11 +88,10 @@ Now click on the code editor on the left side, and let's build our Hello World!
 
 ## Code
 
-Windmill gives you an online editor to work on your Scripts. The left-side is
-the editor itself. The right-side lets you [preview the UI](../../../core_concepts/6_auto_generated_uis/index.md) that Windmill will
+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
 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 there.
+Script. You can easily preview that UI, provide input values, and [test your script](#instant-preview--testing) there.
 
 ![Editor for python](./editor_python.png.webp)
 
diff --git a/docs/getting_started/0_scripts_quickstart/3_go_quickstart/index.mdx b/docs/getting_started/0_scripts_quickstart/3_go_quickstart/index.mdx
@@ -85,10 +85,10 @@ 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**: this is where you can give instructions
-  to users on how to run your Script. It supports markdown!
-- **[Concurrency limits](../../../script_editor/concurrency_limit.mdx)**: it allows you to define 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.md)**, if you want to run some scripts on a GPU machine.
+- **Description** is where you can give instructions through the [auto-generated UI](../../../core_concepts/6_auto_generated_uis/index.md)
+  to users on how to run your Script. It supports markdown.
+- **[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.md)** to assign scripts to specific worker groups (such as nodes with GPU accelaration).
 
 <div class="grid grid-cols-2 gap-6 mb-4">
 	<DocCard
@@ -102,11 +102,10 @@ Now click on the code editor on the left side.
 
 ## Code
 
-Windmill gives you an online editor to work on your Scripts. The left-side is
-the editor itself. The right-side lets you [preview the UI](../../../core_concepts/6_auto_generated_uis/index.md) that Windmill will
+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
 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 there.
+Script. You can easily preview that UI, provide input values, and [test your script](#instant-preview--testing) there.
 
 ![Editor for python](./editor_go.png)
 
diff --git a/docs/getting_started/0_scripts_quickstart/4_bash_quickstart/index.mdx b/docs/getting_started/0_scripts_quickstart/4_bash_quickstart/index.mdx
@@ -98,10 +98,10 @@ 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**: this is where you can give instructions
-  to users on how to run your Script. It supports markdown!
-- **[Concurrency limits](../../../script_editor/concurrency_limit.mdx)**: it allows you to define 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.md)**, if you want to run some scripts on a GPU machine.
+- **Description** is where you can give instructions through the [auto-generated UI](../../../core_concepts/6_auto_generated_uis/index.md)
+  to users on how to run your Script. It supports markdown.
+- **[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.md)** to assign scripts to specific worker groups (such as nodes with GPU accelaration).
 
 <div class="grid grid-cols-2 gap-6 mb-4">
 	<DocCard
@@ -115,11 +115,10 @@ Now click on the code editor on the left side.
 
 ## Code
 
-Windmill gives you an online editor to work on your Scripts. The left-side is
-the editor itself. The right-side lets you [preview the UI](../../../core_concepts/6_auto_generated_uis/index.md) that Windmill will
+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
 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 there.
+Script. You can easily preview that UI, provide input values, and [test your script](#instant-preview--testing) there.
 
 ![Editor for Bash](./editor_bash.png)
 
diff --git a/docs/getting_started/0_scripts_quickstart/6_rest_grapqhql_quickstart/index.mdx b/docs/getting_started/0_scripts_quickstart/6_rest_grapqhql_quickstart/index.mdx
@@ -68,10 +68,10 @@ 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**: this is where you can give instructions
-  to users on how to run your Script. It supports markdown!
-- **[Concurrency limits](../../../script_editor/concurrency_limit.mdx)**: it allows you to define 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.md)**, if you want to run some scripts on a GPU machine.
+- **Description** is where you can give instructions through the [auto-generated UI](../../../core_concepts/6_auto_generated_uis/index.md)
+  to users on how to run your Script. It supports markdown.
+- **[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.md)** to assign scripts to specific worker groups (such as nodes with GPU accelaration).
 
 <div class="grid grid-cols-2 gap-6 mb-4">
 	<DocCard
@@ -85,11 +85,10 @@ Now click on the code editor on the left side.
 
 ## Code
 
-Windmill gives you an online editor to work on your Scripts. The left-side is
-the editor itself. The right-side lets you [preview the UI](../../../core_concepts/6_auto_generated_uis/index.md) that Windmill will
+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
 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 there.
+Script. You can easily preview that UI, provide input values, and [test your script](#instant-preview--testing) there.
 
 ![Editor for GraphQL](./editor_graphql.png "Code Editor GrapQL")
 
diff --git a/docs/getting_started/6_flows_quickstart/index.mdx b/docs/getting_started/6_flows_quickstart/index.mdx
@@ -151,7 +151,7 @@ Your flow can be deepened with [additional features](../../flows/1_flow_editor.m
 
 ### Branching
 
-[Branches](../../flows/13_flow_branches.md) allow you to build branching logic to create and manage complex workflows based on conditions. There are two of them:
+[Branches](../../flows/13_flow_branches.md) build branching logic to create and manage complex workflows based on conditions. There are two of them:
 
 - [Branch one](../../flows/13_flow_branches.md#branch-one): allows you to execute a branch if a condition is true.
 - [Branch all](../../flows/13_flow_branches.md#branch-all): allows you to execute all the branches in parallel, as if each branch is a flow.
diff --git a/sidebars.js b/sidebars.js
@@ -74,21 +74,6 @@ const sidebars = {
 			type: 'category',
 			label: 'Editors Manual',
 			items: [
-				{
-					type: 'category',
-					label: 'Code Editor',
-					link: {
-						type: 'doc',
-						id: 'code_editor/index'
-					},
-					items: [
-						'code_editor/parameter_inference',
-						'code_editor/add_variables_resources',
-						'code_editor/assistants',
-						'code_editor/ai_generation',
-					],
-					collapsed: true
-				},
 				{
 					type: 'category',
 					label: 'Script Editor',
@@ -169,7 +154,22 @@ const sidebars = {
 					],
 
 					collapsed: true
-				}
+				},
+				{
+					type: 'category',
+					label: 'Code Editor',
+					link: {
+						type: 'doc',
+						id: 'code_editor/index'
+					},
+					items: [
+						'code_editor/parameter_inference',
+						'code_editor/add_variables_resources',
+						'code_editor/assistants',
+						'code_editor/ai_generation',
+					],
+					collapsed: true
+				},
 			]
 		},
 		{
