coulomb/citation-work
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
citation-work/SCOPE.md
tegwick 0cd2ca5d04
All checks were successful
CI Smoke / host-smoke (push) Successful in 0s
Details
CI Smoke / container-smoke (push) Successful in 3s
Details
feat: extract review-workspace slice into @citation-evidence/work (CWORK-WP-0001) 
Establishes citation-work as the standalone home of the review workspace,
migrated out of the citation-evidence umbrella app.

- Package/tooling scaffold: package.json, tsconfig, vite/vitest/eslint configs
  with eslint-plugin-boundaries enforcing engine/anchor/source-only imports
- Providers/hooks: EngineProvider, SessionProvider + use* hooks (T02)
- Panes: CollectionList, ViewerShell, EvidenceSidebar (T03/T04/T05)
- Capture/edit: InlineCaptureForm, EvidenceFormBody; UploadDropzone owned here
- ReviewShell: repo-owned three-pane layout with an upload slot seam
- Tests: CollectionList, InlineCaptureForm capture flow, EvidenceSidebar
  export/edit/activation (11 tests, all green)
- Anchor consumed as @citation-evidence/evidence-anchor package; @source kept
  on the umbrella facade for its local viewer-url policy
- Docs (README/SCOPE) refreshed; deferred gaps recorded

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-09 01:49:28 +02:00

3.9 KiB
Raw Blame History

SCOPE

This file helps you quickly understand what this repository is about, when it is relevant, and when it is not. It is intentionally lightweight and may be incomplete.

One-liner

Provides the standalone review-workspace package for citation-evidence: collection pane, viewer shell, annotation capture flow, and evidence sidebar.

Core Idea

Extract the human-facing review workflow out of the umbrella app so the review workspace can evolve as its own package with clear subsystem boundaries.

In Scope

  • Review-mode React surfaces: collection list, viewer shell, evidence sidebar, capture/edit flow
  • Workspace-local providers, hooks, and package exports for the review slice
  • Review-shell composition and related tests/docs

Out of Scope

  • Engine domain model, persistence contracts, and citation renderers
  • Selector-resolution internals and document-ingestion internals
  • Binder-owned evidence-to-form workflows and form UI composition

Relevant When

  • You are extracting or changing the review workspace from citation-evidence
  • You need collection/viewer/sidebar UX without pulling binder concerns into the package
  • You are defining the package surface that the umbrella app will consume for review mode

Not Relevant When

  • You are changing engine contracts or storage semantics
  • You are working on selector algorithms or PDF/HTML/Markdown ingestion internals
  • You are building form-binding, overlays, or evidence-link workflows

Current State

  • Status: extracted (CWORK-WP-0001 complete)
  • Implementation: standalone @citation-evidence/work package; review-workspace slice migrated out of the umbrella app
  • Stability: evolving
  • Usage: internal only

This repo is now the code of record for the review workspace. The umbrella app's @work alias resolves here and it no longer carries a local src/work/ implementation.

How It Fits

  • Upstream dependencies: citation-engine, anchor contracts, source contracts
  • Downstream consumers: citation-evidence umbrella app review mode
  • Often used with: citation-engine, future evidence-anchor, future evidence-source

Terminology

  • Preferred terms: review workspace, collection pane, viewer shell, evidence sidebar
  • Also known as: formerly src/work/ in the umbrella repo (now extracted here)
  • Potentially confusing terms: binder/form workflows are adjacent but not owned here

Related / Overlapping Repositories

  • citation-evidence — umbrella app that currently hosts the source implementation
  • citation-engine — shared types, services, persistence, rendering
  • evidence-anchor — selector creation/resolution and viewer-adapter contracts
  • evidence-source — document ingestion and source-side PDF helpers
  • evidence-binder — adjacent but intentionally not a dependency

Getting Oriented

  • Start with: workplans/CWORK-WP-0001-extract-review-workspace.md
  • Key files / directories: README.md, INTENT.md, src/work/
  • Entry points: src/work/index.ts (the @citation-evidence/work package barrel)

Provided Capabilities

Notes

Anchor is consumed as the extracted @citation-evidence/evidence-anchor package. @source/* still resolves into ../citation-evidence/src/source (the umbrella façade) because that façade owns the local viewer-url policy not present in the extracted evidence-source package — the one remaining transitional edge, tracked in the workplan's deferred list.