Skip to content

Commit 454e8ac

Browse files
committed
docs: Formatting fixes
1 parent 8af897e commit 454e8ac

File tree

2 files changed

+28
-27
lines changed

2 files changed

+28
-27
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ site/
1717
__pycache__/
1818
*.pyc
1919
*.pyo
20+
examples/

docs/user-guide/execution.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ Override model, temperature, or tokens:
8787

8888
```bash
8989
workflow run 01-analysis \
90-
--model claude-3-5-sonnet-20241022 \
91-
--temperature 0.5 \
92-
--max-tokens 8192
90+
--model claude-3-5-sonnet-20241022 \
91+
--temperature 0.5 \
92+
--max-tokens 8192
9393
```
9494

9595
### Custom System Prompts
@@ -157,7 +157,7 @@ Long form:
157157

158158
```bash
159159
workflow task --inline "Extract key action items from the meeting notes" \
160-
--context-file meeting.md
160+
--context-file meeting.md
161161
```
162162

163163
### Named Tasks
@@ -285,10 +285,10 @@ You can freely mix different document types in a single workflow:
285285

286286
```bash
287287
workflow run research \
288-
--input-pattern "data/*.pdf" \
289-
--context-file notes.docx \
290-
--context-file diagram.png \
291-
--context-file references.md
288+
--input-pattern "data/*.pdf" \
289+
--context-file notes.docx \
290+
--context-file diagram.png \
291+
--context-file references.md
292292
```
293293

294294
The tool automatically detects file types and processes each appropriately. PDF and Office files are processed first for optimal performance, followed by text documents and images.
@@ -302,16 +302,16 @@ For **workflow mode (`run`)**:
302302
1. **System prompts:** From `$WORKFLOW_PROMPT_PREFIX/` directory
303303
2. **Project description:** From `.workflow/project.txt` (if non-empty)
304304
3. **Context files and patterns:**
305-
- Config `CONTEXT_FILES` (project-relative)
306-
- Config `CONTEXT_PATTERN` (project-relative)
307-
- CLI `--context-file` flags (PWD-relative)
308-
- CLI `--context-pattern` flags (PWD-relative)
305+
- Config `CONTEXT_FILES` (project-relative)
306+
- Config `CONTEXT_PATTERN` (project-relative)
307+
- CLI `--context-file` flags (PWD-relative)
308+
- CLI `--context-pattern` flags (PWD-relative)
309309
4. **Workflow dependencies:** Via `--depends-on` or `DEPENDS_ON` config
310310
5. **Input files and patterns:**
311-
- Config `INPUT_FILES` (project-relative)
312-
- Config `INPUT_PATTERN` (project-relative)
313-
- CLI `--input-file` flags (PWD-relative)
314-
- CLI `--input-pattern` flags (PWD-relative)
311+
- Config `INPUT_FILES` (project-relative)
312+
- Config `INPUT_PATTERN` (project-relative)
313+
- CLI `--input-file` flags (PWD-relative)
314+
- CLI `--input-pattern` flags (PWD-relative)
315315
6. **Images:** Automatically detected from context/input sources
316316
7. **Task prompt:** The actual task description
317317

@@ -320,11 +320,11 @@ For **task mode (`task`)**:
320320
1. **System prompts:** From `$WORKFLOW_PROMPT_PREFIX/` directory
321321
2. **Project description:** From `.workflow/project.txt` (if in a project)
322322
3. **Context files and patterns:**
323-
- CLI `--context-file` flags (PWD-relative)
324-
- CLI `--context-pattern` flags (PWD-relative)
323+
- CLI `--context-file` flags (PWD-relative)
324+
- CLI `--context-pattern` flags (PWD-relative)
325325
4. **Input files and patterns:**
326-
- CLI `--input-file` flags (PWD-relative)
327-
- CLI `--input-pattern` flags (PWD-relative)
326+
- CLI `--input-file` flags (PWD-relative)
327+
- CLI `--input-pattern` flags (PWD-relative)
328328
5. **Images:** Automatically detected from context/input sources
329329
6. **Task prompt:** The actual task description
330330

@@ -364,9 +364,9 @@ Files are processed in the order specified. For narrative context, order careful
364364

365365
```bash
366366
workflow run draft \
367-
--context-file 00-outline.md \
368-
--context-file 01-introduction.md \
369-
--context-file 02-methods.md
367+
--context-file 00-outline.md \
368+
--context-file 01-introduction.md \
369+
--context-file 02-methods.md
370370
```
371371

372372
## Streaming vs Batch Mode
@@ -488,8 +488,8 @@ workflow run 02-clean-data --depends-on 01-raw-data --stream
488488
workflow run 03-exploratory --depends-on 02-clean-data --stream
489489
workflow run 03-statistical --depends-on 02-clean-data --stream
490490
workflow run 04-final-report \
491-
--depends-on 03-exploratory,03-statistical \
492-
--stream
491+
--depends-on 03-exploratory,03-statistical \
492+
--stream
493493
```
494494

495495
## Output Management
@@ -634,8 +634,8 @@ workflow task -i "What are the main findings?" --context-file results.json
634634

635635
# Quick comparison
636636
workflow task -i "Compare these approaches" \
637-
--context-file approach-a.md \
638-
--context-file approach-b.md
637+
--context-file approach-a.md \
638+
--context-file approach-b.md
639639
```
640640

641641
## Error Handling

0 commit comments

Comments
 (0)