You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/advanced/2_clients/ts_client.mdx
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -59,4 +59,4 @@ export async function main() {
59
59
60
60
In the example above, the `getResource` function is used to retrieve a resource with the path `'u/user/name'` from the Windmill platform. The returned resource can be further processed or used as needed in your application.
61
61
62
-
For more details and documentation on the client, you can visit [jsr.io/@windill/windmill](https://jsr.io/@windmill/windmill), although jsr.io is not supported for actual package imports yet.
62
+
For more details and documentation on the client, you can visit [https://jsr.io/@windmill/windmill](https://jsr.io/@windmill/windmill), although jsr.io is not supported for actual package imports yet.
@@ -33,7 +41,7 @@ Although Windmill provides [auto-generated UIs to scripts and flows](../../core_
33
41
/>
34
42
</div>
35
43
36
-
**Windmill applications are customized UIs to interact with datasources** (web, internal, data providers, etc). They are a great way to have non-technical users interact with custom-made workflows.
44
+
Windmill applications are customized UIs to interact with datasources (web, internal, data providers, etc). They are a great way to have non-technical users interact with custom-made workflows.
37
45
38
46
In short, what you need to remember about apps:
39
47
@@ -53,9 +61,9 @@ From <a href="https://app.windmill.dev/" rel="nofollow">Windmill</a>, click on `
53
61
54
62
### Toolbar
55
63
56
-
Before jumping in, you should decide if you want to build a **Desktop** or a **Mobile** app. Just click on the appropriated icon on top.
64
+
Before jumping in, you should decide if you want to build a Desktop or a Mobile app. Just click on the appropriated icon on top.
57
65
58
-
Switch from **Editor** to **Preview** mode to take a step back on what you're building.
66
+
Switch from Editor to Preview mode to take a step back on what you're building.
59
67
60
68

61
69
@@ -70,9 +78,9 @@ Switch from **Editor** to **Preview** mode to take a step back on what you're bu
70
78
71
79
### Components
72
80
73
-
The App editor works on a drag-and-drop basis. From the right-side menu, click on a component to **create** it on the [canvas](../../apps/1_canvas.mdx), **move** it maintaining a click on it and **delete** it clicking on `Delete component` at the bottom of the `Settings` tab. You can resize your components by dragging the **resize** handler on the bottom-right corner.
81
+
The App editor works on a drag-and-drop basis. From the right-side menu, click on a component to create it on the [canvas](../../apps/1_canvas.mdx), move it maintaining a click on it and delete it clicking on `Delete component` at the bottom of the `Settings` tab. You can resize your components by dragging the resize handler on the bottom-right corner.
74
82
75
-
If you have numerous components you might need to **Anchor** some of them to have them unmovable by other components.
83
+
If you have numerous components you might need to Anchor some of them to have them unmovable by other components.
@@ -82,7 +90,7 @@ If you have numerous components you might need to **Anchor** some of them to hav
82
90
83
91
<br />
84
92
85
-
Check out all of our components at [this page](../../apps/4_app_configuration_settings/1_app_component_library.mdx) or (better) directly from the app editor. Know that **we can quickly add components to the library**, just [reach out to us](../../misc/6_getting_help/index.mdx).
93
+
Check out all of our components at [this page](../../apps/4_app_configuration_settings/1_app_component_library.mdx) or (better) directly from the app editor. Know that we can quickly add components to the library, just [reach out to us](../../misc/6_getting_help/index.mdx).
86
94
87
95
<divclassName="grid grid-cols-2 gap-6 mb-4">
88
96
<DocCard
@@ -111,7 +119,7 @@ From a component, click on `Create an inline script` or `Select a script or flow
The **[Outputs](../../apps/2_outputs.mdx)** of each component can be found on the left side menu. Each of them is associated with a component (see the component id).
122
+
The [Outputs](../../apps/2_outputs.mdx) of each component can be found on the left side menu. Each of them is associated with a component (see the component id).
@@ -134,7 +142,7 @@ The **[Outputs](../../apps/2_outputs.mdx)** of each component can be found on th
134
142
/>
135
143
</div>
136
144
137
-
At any time, have a look at your app's **Inputs** associated with each component on the dedicated `App inputs` tab found in the `⋮` menu of the toolbar.
145
+
At any time, have a look at your app's Inputs associated with each component on the dedicated `App inputs` tab found in the `⋮` menu of the toolbar.
138
146
139
147

140
148
@@ -155,11 +163,11 @@ At any time, have a look at your app's **Inputs** associated with each component
155
163
156
164
### Tailor the look of your app
157
165
158
-
At the **[component level](../../apps/4_app_configuration_settings/4_app_styling.mdx#component-level)**, on the `Settings` tab, configure the style of each component (color, size, label, etc.) either directly in the boxes or using Custom CSS (on the Component Settings - Styling tab).
166
+
At the [component level](../../apps/4_app_configuration_settings/4_app_styling.mdx#component-level), on the `Settings` tab, configure the style of each component (color, size, label, etc.) either directly in the boxes or using Custom CSS (on the Component Settings - Styling tab).
At the **[app level](../../apps/4_app_configuration_settings/4_app_styling.mdx#global-styling)**, you can give a harmonized style to your app with CSS. On the `Global Styling` tab, give details in boxes or in JSON, for the whole app and per class of component.
170
+
At the [app level](../../apps/4_app_configuration_settings/4_app_styling.mdx#global-styling), you can give a harmonized style to your app with CSS. On the `Global Styling` tab, give details in boxes or in JSON, for the whole app and per class of component.
Copy file name to clipboardExpand all lines: docs/misc/0_note_of_intent/index.md
+14-15Lines changed: 14 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -15,17 +15,17 @@ All code is not made equal and can be split in 2 categories:
15
15
code is boilerplate because it _feels_ like you shouldn't have to reinvent the
16
16
wheel, over and over again.
17
17
18
-
Many services labels themselves as **no-code** or **low-code**, as they address
18
+
Many services labels themselves as **no-code** or low-code, as they address
19
19
indeed the challenge of getting rid of the boilerplate and provide a
20
20
comprehensive platform accessible to all members of a diverse organization not
21
-
made solely of engineers. However, **we believe they lack the full power and
21
+
made solely of engineers. However, **we believe they lack the full power and
22
22
flexibility of code** as they either hide it completely, or only allow it under
23
23
restricted forms.
24
24
25
25
Windmill is different:
26
26
27
-
- Windmill is an [open-source](https://github.com/windmill-labs/windmill) developer platform and infra to turn scripts (TypeScript, Python, Go, Bash, SQL) into endpoints, workflows and UIs. In that respect, Windmill is an alternative to Retool, Airplane and n8n.
28
-
- It **empowers semi-technical users** to access and edit that code without
27
+
- Windmill is an [open-source](https://github.com/windmill-labs/windmill) developer platform and infra to turn scripts (TypeScript, Python, Go, Bash, SQL) into endpoints, workflows and UIs. In that respect, Windmill is an alternative to Retool, Prefect and n8n.
28
+
- It empowers semi-technical users to access and edit that code without
29
29
being overwhelmed by the usual barriers to entry (git, IDE, local
30
30
environments, secrets managements, etc).
31
31
- It is compatible with senior/staff software engineers **high standards for
@@ -43,9 +43,9 @@ Windmill embeds:
43
43
minimal cold start
44
44
- a **parser that will infer the dependencies and arguments** from the code
45
45
itself and generate lockfiles and input specs
46
-
- the _lockfile_ allows the script being deployed to maintain exactly the same
46
+
- the _[lockfile](../../advanced/6_imports/index.mdx)_ allows the script being deployed to maintain exactly the same
47
47
set of versioned dependencies forever
48
-
- the in _input spec_ (which is actually a JSON schema) is used to generate a
48
+
- the _[input spec](../../core_concepts/13_json_schema_and_parsing/index.md)_ (which is actually a JSON schema) is used to generate a
49
49
minimal UI automatically for both using the script as a standalone compute
50
50
or as a step of a Flow
51
51
- a powerful **web IDE** to write Scripts with autocompletion and syntax
@@ -78,8 +78,7 @@ Windmill embeds:
78
78
Flows. Combined with state storage, it can be used to watch for external
79
79
events - for example triggering a Flow only if the external state is different
80
80
from the one stored previously
81
-
- a **[CLI](../../advanced/3_cli/index.mdx)** and GitHub Actions for **GitHub** and local
82
-
based development and code management.
81
+
- a **[CLI](../../advanced/3_cli/index.mdx)** and [Git Sync](../../advanced/11_git_sync/index.mdx) to automatically commit and push scripts, flows, and apps to a given repository.
83
82
84
83
On top of all these, you'll get an active [community](https://discord.com/invite/V7PM2YHsPB) and a responsive support
85
84
team to attend you in your journey.
@@ -105,7 +104,7 @@ You can find plenty of examples and inspirations on the
105
104
- Running scripts on a production-grade infra that is cost-efficient, reliable
106
105
and easily monitorable takes a lot of **skill and time to do right**.
107
106
108
-
**Windmill solves those problems**, and makes sure that scripts become widely
107
+
Windmill solves those problems, and makes sure that scripts become widely
109
108
useful tools. The central tenet is: _make building automation fast and easy, and
110
109
everybody will automate repetitive tasks and save a lot of time_.
111
110
@@ -117,14 +116,14 @@ same time. Some other very interesting frameworks that Windmill shares overlap
117
116
with:
118
117
119
118
-_Temporal_ and _Airflow_ for the workflow engine, both open-source. They are
120
-
both **heavily code-based**, have **no low-code builders** for the flows, are
121
-
**complex to set up** and operate, and do not allow to share scripts easily or
119
+
both heavily code-based, have no low-code builders for the flows, are
120
+
complex to set up and operate, and do not allow to share scripts easily or
122
121
build UIs.
123
-
-_Retool_ for building **admin panels**, and its other open-source
122
+
-_Retool_ for building admin panels, and its other open-source
124
123
alternatives: _Tooljet_, _Appsmith_.
125
-
-_Airplane_ and _Superblocks_ have comparable set of features, but **not
126
-
open-source nor self-hostable**, **limited workflow** engines, **not made for
127
-
scalability** and have **no open APIs**.
124
+
-_Airplane_ and _Superblocks_ have comparable set of features, but not
125
+
open-source nor self-hostable, limited workflow engines, not made for
126
+
scalability and have no open APIs.
128
127
129
128
You will find more details on our view over our space and competitors in the
130
129
[Windmill compared to competitors](../../compared_to/peers.mdx) page.
0 commit comments