Skip to content

Commit 4edd0c2

Browse files
committed
📄 docs: update readme and mkdocs.
1 parent a6fc6fc commit 4edd0c2

File tree

12 files changed

+77
-397
lines changed

12 files changed

+77
-397
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,12 @@ flowchart LR
4646
4747
subgraph Docker Container
4848
direction TB
49-
G@{ shape: rounded, label: "Observe<br>Application" }
49+
G@{ shape: rounded, label: "📡Observe<br>Application" }
5050
end
5151
5252
subgraph Docker Container
5353
direction TB
54-
B@{ shape: rounded, label: "Workflow<br>Application" }
54+
B@{ shape: rounded, label: "🏃Workflow<br>Application" }
5555
end
5656
5757
A <-->|action &<br>response| B
@@ -63,7 +63,7 @@ flowchart LR
6363
E@{ shape: lin-cyl, label: "Audit<br>Logs" }
6464
end
6565
66-
subgraph Git Context
66+
subgraph Config Context
6767
F@{ shape: tag-rect, label: "YAML<br>files" }
6868
end
6969
@@ -98,10 +98,10 @@ This project need `ddeutil` and `ddeutil-io` extension namespace packages.
9898
If you want to install this package with application add-ons, you should add
9999
`app` in installation;
100100

101-
| Use-case | Install Optional | Support |
102-
|----------------|--------------------------|--------------------|
103-
| Python | `ddeutil-workflow` | :heavy_check_mark: |
104-
| FastAPI Server | `ddeutil-workflow[api]` | :heavy_check_mark: |
101+
| Use-case | Install Optional | Support |
102+
|----------------|--------------------------|:-------------------:|
103+
| Python | `ddeutil-workflow` | :heavy_check_mark: |
104+
| FastAPI Server | `ddeutil-workflow[api]` | :heavy_check_mark: |
105105

106106
## :beers: Usage
107107

docs/api/cron.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,21 @@ datetime value with next or previous with any start point of an input datetime.
77

88
!!! example "YAML"
99

10-
=== "Corn"
10+
=== "Cron"
1111

1212
```yaml
1313
on_every_5_min:
1414
type: On
1515
cron: "*/5 * * * *"
1616
```
1717

18+
### Fields
19+
20+
| field | data type | default | description |
21+
|----------------|-------------|:-------------:|-------------|
22+
23+
### Usage
24+
1825
```python
1926
from ddeutil.workflow.cron import On
2027

docs/api/logs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
# Logs
2+
3+
## FileTraceLog

docs/api/result.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Result
22

3+
## Status
4+
35
## Result
46

57
Result Pydantic Model for passing and receiving data context from any
@@ -70,9 +72,9 @@ For comparison property, this result will use ``status``, ``context``, and
7072

7173
### Fields
7274

73-
| field | data type | default | description |
74-
|----------------|-------------|:--------:|-------------|
75-
| status | int | `2` | |
76-
| context | DictData | `dict()` | |
77-
| run_id | str \| None | `None` | |
78-
| parent_run_id | str \| None | `None` | |
75+
| field | data type | default | description |
76+
|----------------|-------------|:-------------:|-------------|
77+
| status | int | `Status.WAIT` | |
78+
| context | DictData | `dict()` | |
79+
| run_id | str \| None | `None` | |
80+
| parent_run_id | str \| None | `None` | |

docs/api/stages.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ such as import your installed package.
141141
| field | data type | default | description |
142142
|-------|----------------|:--------:|-------------------------------------------------------------|
143143
| run | str | | A Python string statement that want to run with exec. |
144-
| vars | dict[str, Any] | dict() | A mapping to variable that want to pass to globals in exec. |
144+
| vars | dict[str, Any] | `dict()` | A mapping to variable that want to pass to globals in exec. |
145145

146146
## Call Stage
147147

@@ -173,13 +173,13 @@ objective to invoked by this stage object.
173173
| field | alias | data type | default | description |
174174
|--------|-------|---------------------|:--------:|--------------------------------------------------------------|
175175
| uses | | str | | A pointer that want to load function from the call registry. |
176-
| args | with | dict[str, Any] | dict() | An arguments that want to pass to the call function. |
176+
| args | with | dict[str, Any] | `dict()` | An arguments that want to pass to the call function. |
177177

178178
## Trigger Stage
179179

180180
Trigger Workflow execution stage that execute another workflow. This
181181
the core stage that allow you to create the reusable workflow object or
182-
dynamic parameters workflow for common usecase.
182+
dynamic parameters workflow for common use-case.
183183

184184
!!! example "YAML"
185185

@@ -197,4 +197,4 @@ dynamic parameters workflow for common usecase.
197197
| field | data type | default | description |
198198
|-----------|----------------|:--------:|------------------------------------------------------------------|
199199
| trigger | str | | A trigger workflow name that should already exist on the config. |
200-
| params | dict[str, Any] | dict() | A parameter that want to pass to workflow execution. |
200+
| params | dict[str, Any] | `dict()` | A parameter that want to pass to workflow execution. |

0 commit comments

Comments
 (0)