WORK-485
ID:WORK-485Status:ready

Docs — ProjectFiles contract + fetch-then-build materialization

Document the ProjectFiles contract and the fetch-then-build materialization pattern for remote hosts, so plugin and adapter authors know the seam and how a hosted renderer feeds it.

Priority:mediumComplexity:simpleMilestone:v0.27.0Source:SPEC-113
claude/v0-27-0-planning-sgq68k View source

Criteria completion

Criteria completion: 0 of 2 (0%) checked; tracking started on Jun 25, no incremental history yet0%25%50%75%100%Jun 25Jul 11

Tracking started Jun 25 — check back for trends.

Branches 3
History 1
  1. 4eab338
    Created (ready)by bjornolofandersson

Scope

  • Contract — the ProjectFiles interface (read/list/exists over normalized POSIX keys, containment as contract), the stock providers, and when a consumer should read through it.
  • Materialization — the fetch-then-build recipe (tarball-at-SHA → MapContentTree by key-prefix → memoryProjectFiles + loadContentFromTree), the one-map/tree-derived-from-it point, and the warm-instance / incremental-fetch tradeoff (atomic snapshot vs single-key patch).
  • Cross-link ADR-025 for the incremental-rebuild direction the recordable wrapper enables.

Acceptance Criteria

  • Plugin-authoring / adapter docs describe the ProjectFiles contract and the fetch-then-build materialization pattern for remote hosts.
  • The warm-instance / incremental-fetch tradeoff and the "one map, tree derived from it" model are documented.

Dependencies

  • WORK-484 — the contract is stable once the consumers + loadContentFromTree plumb land.

References

  • SPEC-113 §4 + Acceptance Criteria (docs) · ADR-025 · site/content/extend/plugin-authoring/.