From e725553562420bd719ad31a2a52e214db1137949 Mon Sep 17 00:00:00 2001 From: welsberr Date: Thu, 23 Apr 2026 07:23:13 -0400 Subject: [PATCH] Document doclift downstream workflow --- README.md | 17 +++++++++++++++++ docs/roadmap.md | 10 +++++++--- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ef6c368..34906ca 100755 --- a/README.md +++ b/README.md @@ -67,6 +67,23 @@ Convert a directory tree and inventory external figure assets: doclift convert-dir /path/to/source-tree /tmp/doclift-bundle --asset-root /path/to/source-tree ``` +## Downstream Workflow + +`doclift` is meant to hand off a normalized bundle to downstream systems rather +than to own review, pedagogy, or canonical knowledge storage. + +Minimal end-to-end flow: + +```bash +doclift convert-dir /path/to/legacy-course /tmp/doclift-bundle --asset-root /path/to/legacy-course +didactopus doclift-bundle /tmp/doclift-bundle /tmp/didactopus-pack --course-title "Example Course" +groundrecall import /tmp/doclift-bundle --mode quick +``` + +Use the Didactopus step when you want a learner-facing pack and review workflow. +Use the GroundRecall step when you want to import the normalized source bundle +directly into a canonical knowledge store. + ## Bundle Layout ```text diff --git a/docs/roadmap.md b/docs/roadmap.md index 5feac79..b6a025b 100755 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -3,7 +3,6 @@ ## Near Term - stabilize the normalized bundle schema for downstream adapters -- add a `doclift` bundle consumer path in Didactopus - extend test coverage around table parsing, title repair, and layout manifests - add fixture-based regression tests from representative legacy corpora - improve CLI output for batch conversion summaries @@ -30,6 +29,11 @@ ## Integration -- define a Didactopus source adapter for `doclift` bundles -- define a GroundRecall importer for `doclift` manifests and sidecars +- document and harden the `doclift -> Didactopus -> GroundRecall` handoff path - document provenance mapping from `doclift` artifacts into downstream stores + +## Recently Completed + +- added a Didactopus source adapter for `doclift` bundles +- added a Didactopus CLI path for `doclift` bundle to draft-pack generation +- added a GroundRecall importer for `doclift` manifests and sidecars