generated from coulomb/repo-seed
Establish shared-contracts home, dependency map, MVP workplans, and umbrella-first strategy
- INTENT.md: declare umbrella as the home for shared contracts; document umbrella-first MVP decision (code lives here until subsystems stabilize) - wiki/SharedContracts.md: vocabulary, state enums, relation types, selector taxonomy, event vocabulary, viewer adapter contract, canonical text normalization, rect-registry contract - wiki/DependencyMap.md: allowed dependency edges; folder layout + lint-rule strategy during umbrella-first phase - history/2026-05-24-initial-assessment.md: alignment review, technical risks, and the umbrella-first pivot rationale - workplans/CE-WP-0001..0004: four ralph-compatible workplans covering foundations, PDF review slice, form binding + visual guide, and citation card export — implementing PRD §20 end-to-end Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
41
workplans/README.md
Normal file
41
workplans/README.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# MVP Workplans
|
||||
|
||||
These four workplans implement the **first reference scenario** from
|
||||
`wiki/ProductRequirementsDocument.md` §20 — end-to-end PDF evidence
|
||||
capture → form binding → citation card export — entirely inside the
|
||||
`citation-evidence` repository.
|
||||
|
||||
| Workplan | Title | Status |
|
||||
|----------|----------------------------------------|--------|
|
||||
| `CE-WP-0001` | Foundations — scaffold, folders, lint rules, normalize, fixtures | todo |
|
||||
| `CE-WP-0002` | PDF review slice — engine types, anchor, source, viewer, sidebar | todo |
|
||||
| `CE-WP-0003` | Form binding + visual guide — EvidenceLink, rect registry, overlay | todo |
|
||||
| `CE-WP-0004` | Citation card export — Markdown + HTML renderers, sidebar export | todo |
|
||||
|
||||
## Order
|
||||
|
||||
Strictly sequential. `CE-WP-0002` depends on the folder/lint scaffolding from
|
||||
`CE-WP-0001`. `CE-WP-0003` and `CE-WP-0004` depend on the engine types,
|
||||
viewer adapter, and sidebar from `CE-WP-0002`.
|
||||
|
||||
## How to run a workplan
|
||||
|
||||
```
|
||||
/ralph-workplan workplans/CE-WP-0001-foundations.md
|
||||
```
|
||||
|
||||
Ralph drives the loop and retires automatically when all tasks in the
|
||||
workplan are marked `done`. See `~/.claude/plugins/ralph-workplan/ralph-workplan.md`.
|
||||
|
||||
## Acceptance for MVP
|
||||
|
||||
The first reference scenario from PRD §20 runs end-to-end:
|
||||
|
||||
1. Create a collection
|
||||
2. Upload a PDF
|
||||
3. Select a passage, add commentary, create an evidence item
|
||||
4. Open a side-by-side form
|
||||
5. Link the evidence item to a form field
|
||||
6. Focus the field → field, evidence card, and PDF passage all highlighted
|
||||
7. SVG guide visible between field → card → highlight
|
||||
8. Export evidence as a Markdown citation card
|
||||
Reference in New Issue
Block a user