Skip to content

Commit c23f63d

Browse files
authored
docs: switch to history router (#289)
1 parent 0679f69 commit c23f63d

File tree

17 files changed

+44
-40
lines changed

17 files changed

+44
-40
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
</p>
99

1010
<p align="center">
11-
<b>flow</b> is your personal workflow hub - organize automation across all your projects with built-in secrets, templates, and cross-project composition.
12-
Define workflows in YAML, discover them visually, and run them anywhere.
11+
<b>flow</b> is your local-first developer platform - organize automation across all your projects with built-in secrets, templates, and cross-project workflows.
12+
Define workflows in YAML, browse auto-generated documentation, and run them anywhere.
1313
</p>
1414

1515
---
@@ -83,14 +83,14 @@ flow browse
8383

8484
**Complete documentation at [flowexec.io](https://flowexec.io)**
8585

86-
- [Installation](https://flowexec.io/#/installation) - Multiple installation methods
87-
- [Quick Start](https://flowexec.io/#/quickstart) - Get up and running in 5 minutes
88-
- [Core Concepts](https://flowexec.io/#/guide/concepts) - Understand workspaces, executables, and vaults
89-
- [User Guides](https://flowexec.io/#/guide/README) - Comprehensive guides for all features
86+
- [Installation](https://flowexec.io/installation) - Multiple installation methods
87+
- [Quick Start](https://flowexec.io/quickstart) - Get up and running in 5 minutes
88+
- [Core Concepts](https://flowexec.io/guide/concepts) - Understand workspaces, executables, and vaults
89+
- [User Guides](https://flowexec.io/guide/README) - Comprehensive guides for all features
9090

9191
## Community
9292

9393
- [Discord Community](https://discord.gg/CtByNKNMxM) - Get help and share workflows
9494
- [Issue Tracker](https://github.com/flowexec/flow/issues) - Report bugs and request features
9595
- [Examples Repository](https://github.com/flowexec/examples) - Real-world workflow patterns
96-
- [Contributing Guide](https://flowexec.io/#/development) - Help make flow better
96+
- [Contributing Guide](https://flowexec.io/development) - Help make flow better

desktop/src-tauri/src/types/generated/template.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ pub mod error {
5757
#[doc = " \"type\": \"string\""]
5858
#[doc = " },"]
5959
#[doc = " \"if\": {"]
60-
#[doc = " \"description\": \"An expression that determines whether the the artifact should be copied, using the Expr language syntax. \\nThe expression is evaluated at runtime and must resolve to a boolean value. If the condition is not met, \\nthe artifact will not be copied.\\n\\nThe expression has access to OS/architecture information (os, arch), environment variables (env), form input \\n(form), and context information (name, workspace, directory, etc.).\\n\\nSee the [flow documentation](https://flowexec.io/#/guide/templating) for more information.\\n\","]
60+
#[doc = " \"description\": \"An expression that determines whether the the artifact should be copied, using the Expr language syntax. \\nThe expression is evaluated at runtime and must resolve to a boolean value. If the condition is not met, \\nthe artifact will not be copied.\\n\\nThe expression has access to OS/architecture information (os, arch), environment variables (env), form input \\n(form), and context information (name, workspace, directory, etc.).\\n\\nSee the [flow documentation](https://flowexec.io/guide/templating) for more information.\\n\","]
6161
#[doc = " \"default\": \"\","]
6262
#[doc = " \"type\": \"string\""]
6363
#[doc = " },"]
@@ -85,7 +85,7 @@ pub struct Artifact {
8585
#[doc = "The name of the file to copy to. If not set, the file will be copied with the same name."]
8686
#[serde(rename = "dstName", default)]
8787
pub dst_name: ::std::string::String,
88-
#[doc = "An expression that determines whether the the artifact should be copied, using the Expr language syntax. \nThe expression is evaluated at runtime and must resolve to a boolean value. If the condition is not met, \nthe artifact will not be copied.\n\nThe expression has access to OS/architecture information (os, arch), environment variables (env), form input \n(form), and context information (name, workspace, directory, etc.).\n\nSee the [flow documentation](https://flowexec.io/#/guide/templating) for more information.\n"]
88+
#[doc = "An expression that determines whether the the artifact should be copied, using the Expr language syntax. \nThe expression is evaluated at runtime and must resolve to a boolean value. If the condition is not met, \nthe artifact will not be copied.\n\nThe expression has access to OS/architecture information (os, arch), environment variables (env), form input \n(form), and context information (name, workspace, directory, etc.).\n\nSee the [flow documentation](https://flowexec.io/guide/templating) for more information.\n"]
8989
#[serde(rename = "if", default)]
9090
pub if_: ::std::string::String,
9191
#[doc = "The directory to copy the file from. \nIf not set, the file will be copied from the directory of the template file.\n"]
@@ -460,7 +460,7 @@ impl Template {
460460
#[doc = " \"type\": \"string\""]
461461
#[doc = " },"]
462462
#[doc = " \"if\": {"]
463-
#[doc = " \"description\": \"An expression that determines whether the executable should be run, using the Expr language syntax. \\nThe expression is evaluated at runtime and must resolve to a boolean value. If the condition is not met, \\nthe executable will be skipped.\\n\\nThe expression has access to OS/architecture information (os, arch), environment variables (env), form input \\n(form), and context information (name, workspace, directory, etc.).\\n\\nSee the [flow documentation](https://flowexec.io/#/guide/templating) for more information.\\n\","]
463+
#[doc = " \"description\": \"An expression that determines whether the executable should be run, using the Expr language syntax. \\nThe expression is evaluated at runtime and must resolve to a boolean value. If the condition is not met, \\nthe executable will be skipped.\\n\\nThe expression has access to OS/architecture information (os, arch), environment variables (env), form input \\n(form), and context information (name, workspace, directory, etc.).\\n\\nSee the [flow documentation](https://flowexec.io/guide/templating) for more information.\\n\","]
464464
#[doc = " \"default\": \"\","]
465465
#[doc = " \"type\": \"string\""]
466466
#[doc = " },"]
@@ -481,7 +481,7 @@ pub struct TemplateRefConfig {
481481
#[doc = "The command to execute.\nOne of `cmd` or `ref` must be set.\n"]
482482
#[serde(default)]
483483
pub cmd: ::std::string::String,
484-
#[doc = "An expression that determines whether the executable should be run, using the Expr language syntax. \nThe expression is evaluated at runtime and must resolve to a boolean value. If the condition is not met, \nthe executable will be skipped.\n\nThe expression has access to OS/architecture information (os, arch), environment variables (env), form input \n(form), and context information (name, workspace, directory, etc.).\n\nSee the [flow documentation](https://flowexec.io/#/guide/templating) for more information.\n"]
484+
#[doc = "An expression that determines whether the executable should be run, using the Expr language syntax. \nThe expression is evaluated at runtime and must resolve to a boolean value. If the condition is not met, \nthe executable will be skipped.\n\nThe expression has access to OS/architecture information (os, arch), environment variables (env), form input \n(form), and context information (name, workspace, directory, etc.).\n\nSee the [flow documentation](https://flowexec.io/guide/templating) for more information.\n"]
485485
#[serde(rename = "if", default)]
486486
pub if_: ::std::string::String,
487487
#[doc = "A reference to another executable to run in serial.\nOne of `cmd` or `ref` must be set.\n"]

desktop/src/types/generated/template.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ export interface Artifact {
6262
* The expression has access to OS/architecture information (os, arch), environment variables (env), form input
6363
* (form), and context information (name, workspace, directory, etc.).
6464
*
65-
* See the [flow documentation](https://flowexec.io/#/guide/templating) for more information.
65+
* See the [flow documentation](https://flowexec.io/guide/templating) for more information.
6666
*
6767
*/
6868
if?: string;
@@ -138,7 +138,7 @@ export interface TemplateRefConfig {
138138
* The expression has access to OS/architecture information (os, arch), environment variables (env), form input
139139
* (form), and context information (name, workspace, directory, etc.).
140140
*
141-
* See the [flow documentation](https://flowexec.io/#/guide/templating) for more information.
141+
* See the [flow documentation](https://flowexec.io/guide/templating) for more information.
142142
*
143143
*/
144144
if?: string;

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
<a href="https://github.com/flowexec/flow"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/flowexec/flow"></a>
88
</p>
99

10-
flow is your personal **workflow hub** - organize automation across all your projects with built-in secrets, templates,
11-
and cross-project composition. Go beyond task running to workflow management that scales with your development ecosystem.
10+
flow is a local-first developer platform - organize automation across all your projects with built-in secrets, templates, and cross-project workflows.
11+
Go beyond task running to workflow management that scales with your development ecosystem.
1212

1313
#### _Why flow?_ <!-- {docsify-ignore} -->
1414

docs/_coverpage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# flow
44

5-
> _Interactive CLI automation that flows with you._
5+
> _Local developer platform that flows with you._
66
77
- Define your _executables_ in YAML
88
- Browse and execute with ease

docs/cli/flow_browse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Browse executables across workspaces.
1010
flow browse --list # Simple list view of executables
1111
flow browse VERB [ID] # Detailed view of specific executable
1212

13-
See https://flowexec.io/#/types/flowfile#executableverb for more information on executable verbs and https://flowexec.io/#/types/flowfile#executableref for more information on executable references.
13+
See https://flowexec.io/types/flowfile?id=executableverb for more information on executable verbs and https://flowexec.io/types/flowfile?id=executableref for more information on executable references.
1414

1515
```
1616
flow browse [EXECUTABLE-REFERENCE] [flags]

docs/cli/flow_exec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ If the target executable accept arguments, they can be passed in the form of fla
1212
Flag arguments are specified with the format 'flag=value' and positional arguments are specified as values without any prefix.
1313

1414

15-
See https://flowexec.io/#/types/flowfile#executableverb for more information on executable verbs and https://flowexec.io/#/types/flowfile#executableref for more information on executable IDs.
15+
See https://flowexec.io/types/flowfile?id=executableverb for more information on executable verbs and https://flowexec.io/types/flowfile?id=executableref for more information on executable IDs.
1616

1717

1818
#### Examples

docs/guide/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Take your automation to the next level:
2424
- **[Templates & Code Generation](templating.md)** - Generate workflows and project scaffolding
2525
- **[Advanced Workflows](advanced.md)** - Complex automation with conditionals, state, and composition
2626
- **[Interactive UI](interactive.md)** - Customize and use the terminal interface
27-
- **[Integrations](integrations.md)** - Run flow in CI/CD and containerized environments
27+
- **[Integrations](integrations.md)** - Run flow in MCP clients, GitHub Actions, and containerized environments
2828

2929
## Other Resources
3030

docs/guide/advanced.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -371,20 +371,24 @@ executables:
371371
cmd: ./deploy.sh
372372
```
373373

374+
> [!NOTE]
375+
> In serial and parallel executables, `params` and `args` that are defined at the parent level will apply to all
376+
> child executables. Argument from the parent -> child executable should use matching `EnvKey` to ensure proper resolution.
377+
374378
**Resolution example:**
375379
```shell
376380
# Shell environment
377-
export ENVIRONMENT=development
378381
export API_KEY=shell-key
379382
export VERBOSE=true
383+
export ENVIRONMENT=development
380384
381385
# Command execution
382386
flow deploy app verbose=false --param ENVIRONMENT=production
383387
384388
# Final environment variables:
385-
# ENVIRONMENT=production (--param override wins)
386389
# API_KEY=<secret-value> (params wins over shell)
387-
# VERBOSE=false (args wins over shell)
390+
# VERBOSE=false (args wins over shell and params)
391+
# ENVIRONMENT=production (--param override wins over all)
388392
```
389393

390394
### Environment Variable Expansion <!-- {docsify-ignore} -->

docs/index.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,14 @@
4040
subMaxLevel: 3,
4141
coverpage: true,
4242
onlyCover: false,
43-
nameLink: '#/README',
43+
nameLink: 'README',
4444
auto2top: true,
45+
routerMode: 'history',
4546
alias: {
4647
'/releases/(.*)': 'https://github.com/flowexec/flow/releases/$1',
4748
'/schemas/(.*)': 'https://github.com/flowexec/flow/tree/main/schemas/$1',
4849
'/issues/(.*)': 'https://github.com/flowexec/flow/issues/$1',
50+
'/(.*)/_sidebar.md': '$1/_sidebar.md',
4951
},
5052
copyCode: {
5153
buttonText: 'Copy',

0 commit comments

Comments
 (0)