Skip to content

docs(architecture): S2 — role & seams orientation doc (#72)#79

Merged
Polichinel merged 1 commit into
developmentfrom
docs/s2-role-and-seams
Jun 27, 2026
Merged

docs(architecture): S2 — role & seams orientation doc (#72)#79
Polichinel merged 1 commit into
developmentfrom
docs/s2-role-and-seams

Conversation

@Polichinel

Copy link
Copy Markdown
Collaborator

Epic: #70 · S2 (#72) · depends on #71

Adds docs/architecture/role_and_seams.md — the highest-value gap: the doc that explains the repo's role vs the sibling repos and its internal seams. Content verified against the code this session:

  • Topology: datafactory → pipeline-core → vpp → faoapi; dependency direction strictly down; pipeline-core does not import vpp.
  • What vpp is: a pipeline-core postprocessor (Template Method); fills the post-forecast slot with delivery + integrity; statistics live downstream (collapse in faoapi, reconciliation in views_frames_reconcile).
  • Three seams: delivery/ invariants vs unfao/extraction.py; the inherited pandas base + C-40; points vs draws (FAO delivery path is point/DataFrame-based — won't carry rusty_bucket's pooled draws #45).
  • A package/module map.

Docs-only; ruff clean, suite green.

Closes #72

🤖 Generated with Claude Code

Adds docs/architecture/role_and_seams.md — the orientation doc a newcomer reads
first: the platform topology (datafactory -> pipeline-core -> vpp -> faoapi, one-way
down; pipeline-core does not import vpp), what this repo is (a pipeline-core
postprocessor / Template-Method subclass filling the post-forecast slot with
delivery + integrity, not statistics), and the three seams — delivery/ invariants
vs unfao/extraction.py; the inherited pandas base and the C-40 gate; points vs
draws (#45). Plus a package map. Docs-only.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@Polichinel Polichinel merged commit fd0394b into development Jun 27, 2026
4 checks passed
@Polichinel Polichinel deleted the docs/s2-role-and-seams branch June 27, 2026 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant