Skip to content

Commit 28f587b

Browse files
docs(EXPLAINME): convert 7 Markdown code fences to AsciiDoc source blocks (#60)
## Summary - Converts 14 Markdown triple-backtick markers (7 code blocks) in `EXPLAINME.adoc` to AsciiDoc `[source,lang]` / `----` form so embedded JSON/bash snippets render as code blocks rather than literal backtick-fenced text. - All 7 blocks live inside numbered list items, so each gets `+` continuation markers to preserve list attachment. - Part of the cross-estate "EXPLAINME.adoc quote fixes" sweep. ## Test plan - [ ] CI asciidoctor render passes - [ ] Visual inspection of rendered HTML shows code-block styling (not literal backticks) for all 7 snippets - [ ] Numbered list structure remains contiguous (no orphaned items after blocks) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent f7089ea commit 28f587b

1 file changed

Lines changed: 55 additions & 41 deletions

File tree

EXPLAINME.adoc

Lines changed: 55 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,25 @@ ____
1919
The filesystem automation engine (`crates/rpa-fs-workflow/`) implements a complete task automation pipeline:
2020

2121
1. **Workflow Definition**: Users write a YAML/JSON workflow config (example: `examples/sync-and-archive.json`):
22-
```json
23-
{
24-
"workflow_id": "sync_archive_001",
25-
"rules": [
26-
{
27-
"trigger": "file.created",
28-
"watch_path": "/data/inbox/*",
29-
"patterns": ["*.pdf"],
30-
"actions": [
31-
{"type": "copy", "dest": "/archive/{date}"},
32-
{"type": "extract-metadata", "tool": "exiftool"},
33-
{"type": "http-post", "url": "https://api.example.com/log"}
34-
]
35-
}
36-
]
37-
}
38-
```
22+
+
23+
[source,json]
24+
----
25+
{
26+
"workflow_id": "sync_archive_001",
27+
"rules": [
28+
{
29+
"trigger": "file.created",
30+
"watch_path": "/data/inbox/*",
31+
"patterns": ["*.pdf"],
32+
"actions": [
33+
{"type": "copy", "dest": "/archive/{date}"},
34+
{"type": "extract-metadata", "tool": "exiftool"},
35+
{"type": "http-post", "url": "https://api.example.com/log"}
36+
]
37+
}
38+
]
39+
}
40+
----
3941

4042
2. **File System Watcher**: `notify` crate (Rust) monitors `watch_path` for create/modify/delete/rename events. On match, extracts event metadata (path, timestamp, file size).
4143

@@ -247,22 +249,28 @@ The WASM plugin system has critical limitations:
247249
=== Build & Run the CLI
248250

249251
1. Clone and build:
250-
```bash
251-
cd /var/mnt/eclipse/repos/rpa-elysium
252-
cargo build --release -p rpa-fs-workflow
253-
```
252+
+
253+
[source,bash]
254+
----
255+
cd /var/mnt/eclipse/repos/rpa-elysium
256+
cargo build --release -p rpa-fs-workflow
257+
----
254258

255259
2. Watch a folder for file creation:
256-
```bash
257-
./target/release/rpa-fs \
258-
--workflow examples/sync-and-archive.json \
259-
--watch /tmp/inbox
260-
```
260+
+
261+
[source,bash]
262+
----
263+
./target/release/rpa-fs \
264+
--workflow examples/sync-and-archive.json \
265+
--watch /tmp/inbox
266+
----
261267

262268
3. In another terminal, create a file:
263-
```bash
264-
touch /tmp/inbox/test.pdf
265-
```
269+
+
270+
[source,bash]
271+
----
272+
touch /tmp/inbox/test.pdf
273+
----
266274

267275
4. Observe the CLI:
268276
- Logs file creation event
@@ -273,11 +281,13 @@ The WASM plugin system has critical limitations:
273281
=== Test Type Safety
274282

275283
1. Intentionally break a workflow config:
276-
```bash
277-
# Missing required field "watch_path"
278-
cargo run -p rpa-fs-workflow -- --workflow broken.json
279-
# Error: ConfigError::MissingField("watch_path")
280-
```
284+
+
285+
[source,bash]
286+
----
287+
# Missing required field "watch_path"
288+
cargo run -p rpa-fs-workflow -- --workflow broken.json
289+
# Error: ConfigError::MissingField("watch_path")
290+
----
281291

282292
2. Rust compile-time prevents task mismatches:
283293
- If a task expects a file path input but receives an HTTP response, compilation fails
@@ -286,15 +296,19 @@ The WASM plugin system has critical limitations:
286296
=== Test Plugin System
287297

288298
1. Write a WASM plugin (example: sum numbers):
289-
```bash
290-
# Use provided Wasm template or bring your own
291-
wasm-pack build --target web plugin-example/
292-
```
299+
+
300+
[source,bash]
301+
----
302+
# Use provided Wasm template or bring your own
303+
wasm-pack build --target web plugin-example/
304+
----
293305

294306
2. Reference plugin in workflow:
295-
```json
296-
{"type": "plugin", "name": "sum-numbers", "input": {"values": [1, 2, 3]}}
297-
```
307+
+
308+
[source,json]
309+
----
310+
{"type": "plugin", "name": "sum-numbers", "input": {"values": [1, 2, 3]}}
311+
----
298312

299313
3. Run workflow and observe JSON I/O to plugin
300314

0 commit comments

Comments
 (0)