Document doclift downstream workflow
This commit is contained in:
parent
bb8d54aa15
commit
e725553562
17
README.md
17
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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Reference in New Issue