From 72fdf4c60d77535472113884c8b35c24b5b8883f Mon Sep 17 00:00:00 2001 From: Jon Langevin Date: Sun, 22 Feb 2026 23:14:26 -0500 Subject: [PATCH 1/2] fix: correct example count from 100+ to 27 in documentation The example/ directory contains 27 YAML config files, not 100+. Updated all references across README.md, CONTRIBUTING.md, docs/tutorials/getting-started.md, and docs/adr/001-yaml-driven-config.md. Closes #70 Co-Authored-By: Claude Opus 4.6 --- CONTRIBUTING.md | 2 +- README.md | 6 +++--- docs/adr/001-yaml-driven-config.md | 2 +- docs/tutorials/getting-started.md | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dbc36fb8..19b3d43c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,7 +46,7 @@ schema/ JSON Schema generation and validation middleware/ HTTP middleware (validation, rate limiting) audit/ Structured audit logging ui/ React + ReactFlow visual builder -example/ 100+ YAML configs and application examples +example/ 27 YAML configs and application examples mock/ Test helpers docs/ API docs, tutorials, ADRs ``` diff --git a/README.md b/README.md index 29efbda9..017cab31 100644 --- a/README.md +++ b/README.md @@ -191,9 +191,9 @@ graph LR A 10+ module workflow demonstrating module composition with HTTP servers, routers, handlers, data transformers, state machines, message brokers, and observability. See [`example/order-processing-pipeline.yaml`](example/order-processing-pipeline.yaml). -### 100+ Example Configurations +### Example Configurations -The [`example/`](example/) directory contains configurations covering: +The [`example/`](example/) directory contains 27 YAML configurations covering: - API gateways and reverse proxies - Event-driven and scheduled workflows @@ -223,7 +223,7 @@ ai/ AI integration layer service.go Provider selection and orchestration deploy.go Validation loop and deployment to dynamic components ui/ React + ReactFlow + Zustand visual builder (Vite, TypeScript) -example/ 100+ YAML configs and 2 full application examples +example/ 27 YAML configs and 2 full application examples mock/ Test helpers and mock implementations ``` diff --git a/docs/adr/001-yaml-driven-config.md b/docs/adr/001-yaml-driven-config.md index 3577b7b5..43c7b90a 100644 --- a/docs/adr/001-yaml-driven-config.md +++ b/docs/adr/001-yaml-driven-config.md @@ -10,6 +10,6 @@ The workflow engine needs a way to define applications. The two main approaches We chose YAML as the primary configuration format. All module composition, workflow definitions, trigger configuration, and runtime behavior are specified in YAML files. One file per application (or per service in distributed mode). ## Consequences -**Positive**: Non-developers can create applications; configs are validatable via JSON Schema; enables visual builder UI with YAML import/export; runtime reconfiguration without recompilation; 100+ example configs as documentation; easy to version control and diff. +**Positive**: Non-developers can create applications; configs are validatable via JSON Schema; enables visual builder UI with YAML import/export; runtime reconfiguration without recompilation; 27 example configs as documentation; easy to version control and diff. **Negative**: Complex logic requires dynamic components (Yaegi); YAML syntax errors can be cryptic; some configs are verbose vs code. Mitigated by JSON Schema validation, wfctl validate CLI, example configs, and visual builder UI. diff --git a/docs/tutorials/getting-started.md b/docs/tutorials/getting-started.md index 522222ab..2b86b35e 100644 --- a/docs/tutorials/getting-started.md +++ b/docs/tutorials/getting-started.md @@ -26,7 +26,7 @@ Visit http://localhost:8080 to see your server running. ### 3. Explore Example Configs -The `example/` directory contains 100+ YAML configurations: +The `example/` directory contains 27 YAML configurations: ```bash ls example/*.yaml | head -20 From 7ead26fe4675def7df08c540acc942e985b4dfc5 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Mon, 23 Feb 2026 01:48:52 -0500 Subject: [PATCH 2/2] docs: clarify example/ config counts to avoid misleading totals (#111) * Initial plan * docs: clarify example counts per review suggestions Co-authored-by: intel352 <77607+intel352@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: intel352 <77607+intel352@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- README.md | 4 ++-- docs/adr/001-yaml-driven-config.md | 2 +- docs/tutorials/getting-started.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 19b3d43c..3b6fa1ff 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,7 +46,7 @@ schema/ JSON Schema generation and validation middleware/ HTTP middleware (validation, rate limiting) audit/ Structured audit logging ui/ React + ReactFlow visual builder -example/ 27 YAML configs and application examples +example/ YAML configs and application examples mock/ Test helpers docs/ API docs, tutorials, ADRs ``` diff --git a/README.md b/README.md index 017cab31..86324f30 100644 --- a/README.md +++ b/README.md @@ -193,7 +193,7 @@ A 10+ module workflow demonstrating module composition with HTTP servers, router ### Example Configurations -The [`example/`](example/) directory contains 27 YAML configurations covering: +The [`example/`](example/) directory contains 27 top-level `example/*.yaml` configurations covering: - API gateways and reverse proxies - Event-driven and scheduled workflows @@ -223,7 +223,7 @@ ai/ AI integration layer service.go Provider selection and orchestration deploy.go Validation loop and deployment to dynamic components ui/ React + ReactFlow + Zustand visual builder (Vite, TypeScript) -example/ 27 YAML configs and 2 full application examples +example/ Top-level example YAML configs and full application examples mock/ Test helpers and mock implementations ``` diff --git a/docs/adr/001-yaml-driven-config.md b/docs/adr/001-yaml-driven-config.md index 43c7b90a..ad522205 100644 --- a/docs/adr/001-yaml-driven-config.md +++ b/docs/adr/001-yaml-driven-config.md @@ -10,6 +10,6 @@ The workflow engine needs a way to define applications. The two main approaches We chose YAML as the primary configuration format. All module composition, workflow definitions, trigger configuration, and runtime behavior are specified in YAML files. One file per application (or per service in distributed mode). ## Consequences -**Positive**: Non-developers can create applications; configs are validatable via JSON Schema; enables visual builder UI with YAML import/export; runtime reconfiguration without recompilation; 27 example configs as documentation; easy to version control and diff. +**Positive**: Non-developers can create applications; configs are validatable via JSON Schema; enables visual builder UI with YAML import/export; runtime reconfiguration without recompilation; many example configs as documentation; easy to version control and diff. **Negative**: Complex logic requires dynamic components (Yaegi); YAML syntax errors can be cryptic; some configs are verbose vs code. Mitigated by JSON Schema validation, wfctl validate CLI, example configs, and visual builder UI. diff --git a/docs/tutorials/getting-started.md b/docs/tutorials/getting-started.md index 2b86b35e..e3e2933c 100644 --- a/docs/tutorials/getting-started.md +++ b/docs/tutorials/getting-started.md @@ -26,7 +26,7 @@ Visit http://localhost:8080 to see your server running. ### 3. Explore Example Configs -The `example/` directory contains 27 YAML configurations: +The `example/` directory contains 27 top-level `example/*.yaml` configurations, plus additional configs under application subdirectories: ```bash ls example/*.yaml | head -20