From 676ed5b5cf3ea263808f9bb79b21f03b355a07af Mon Sep 17 00:00:00 2001 From: scawful Date: Tue, 30 Dec 2025 16:15:29 -0500 Subject: [PATCH] docs: note generator workflow --- README.md | 1 + docs/ROADMAP.md | 3 ++- docs/STATUS.md | 6 +++--- docs/TRAINING_ROADMAP.md | 3 ++- 4 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5f2f3ef..5e9e3b4 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ Quickstart: - `python -m afs_scawful datasets index` - `python -m afs_scawful resources index` - `python -m afs_scawful validators list` +- `python -m afs_scawful generators doc-sections --output ~/src/training/index/doc_sections.jsonl` Mounts (AFS Studio): - Create `mounts.json` in `~/.config/afs/afs_scawful/` or `~/.config/afs/plugins/afs_scawful/config/` diff --git a/docs/ROADMAP.md b/docs/ROADMAP.md index 7affd1b..c8c73d7 100644 --- a/docs/ROADMAP.md +++ b/docs/ROADMAP.md @@ -5,9 +5,10 @@ - Dataset registry indexing CLI - Resource indexing CLI - Validator base + initial validators (ASM/C++/KG/ASAR) +- Generator base + doc-section generator ## Planned -- Generator base + one small generator +- Generator QA summary + manifest output - Training monitor schema validation ## Ideas diff --git a/docs/STATUS.md b/docs/STATUS.md index 5fea0de..935f277 100644 --- a/docs/STATUS.md +++ b/docs/STATUS.md @@ -1,7 +1,7 @@ # STATUS Stage: Prototype -Now: config helpers; dataset registry builder; resource indexer; training sample model; validator base + initial validators; pytest coverage. -Not yet: generators; training runner; dataset QA reports. -Next: port one generator; add validator CLI examples; wire reports into AFS Studio. +Now: config helpers; dataset registry builder; resource indexer; training sample model; validator base + initial validators; doc-section generator; pytest coverage. +Not yet: more generators; training runner; dataset QA reports. +Next: add generator QA summary + manifest; wire generator outputs into AFS Studio. Issues: no training runtime yet. diff --git a/docs/TRAINING_ROADMAP.md b/docs/TRAINING_ROADMAP.md index 2120e98..5f7d72f 100644 --- a/docs/TRAINING_ROADMAP.md +++ b/docs/TRAINING_ROADMAP.md @@ -7,10 +7,11 @@ Scope: AFS Scawful training data pipelines and monitoring. Research-only. - Resource indexing (local) - Plugin config loader for training paths/resources - Validator base + initial validators (ASM/C++/KG/ASAR) +- Generator base + doc-section generator ## Planned (near-term) -- Generator base + one small generator - Training monitor schema validation and config docs +- Generator QA summary + manifest output ## Planned (mid-term) - Generator runner that produces dataset manifests