Repository navigation
Correct public attachment documentation and publish executable capability examples #904
Description
Activity
- addedtype:docsDocumentation work.Documentation work.priority:asapImmediate release pressure.Immediate release pressure.area:docsPrimary work area: docs.Primary work area: docs.status:availableOpen and available for prioritization; not blocked or actively in progress.Open and available for prioritization; not blocked or actively in progress.
on Sep 29, 2026 Dependency re-audit (2026-10-01)
Mixed timing: current honesty corrections can land immediately, but completion includes real restored examples and agreed structural-ownership distinctions. This is a completion blocker, not a ban on starting docs.
Completion prerequisites:
- Restore public node and edge content attachments after the v19 API migration #901 / FLY-256: The complete documentation card requires executable supported-package attach/replace/clear/stream examples. Honesty corrections can start now, but the card cannot finish while those operations are missing.
- Define recursive attachment ownership and descendant-preserving mutation semantics #903 / FLY-258: The documentation must distinguish finite structural ownership from byte assets and external/live references using the agreed ownership and descendant-mutation contract. Current-capability corrections can land early.
Early investigation or an independently green preparatory slice may start sooner; closing this card requires the complete outcome. No broken intermediate mainline or host test execution is acceptable.
Full 232-card review: https://linear.app/flyingrobots/document/dependency-decisions-all-232-open-git-warp-issues-2026-10-01-abfe8f9fec63
- addedstatus:blockedBlocked by an explicit dependency or external condition.Blocked by an explicit dependency or external condition.template:featureCard template: featureCard template: featureand removedstatus:availableOpen and available for prioritization; not blocked or actively in progress.Open and available for prioritization; not blocked or actively in progress.
on Oct 1, 2026 - addedstatus:activeSomeone is actively working this issue.Someone is actively working this issue.and removedstatus:blockedBlocked by an explicit dependency or external condition.Blocked by an explicit dependency or external condition.
on Oct 2, 2026 Draft PR #938: #938 at
a8a81d6f7587f8136a63bc3e9c75b0ffa07f0158, based on #932's ownership contract (bc7d3b98197b3b43b753b65a035f33d94daeaa28). The four-file documentation change distinguishes published v19.1.0 from the restored source API, documents both attachment owners' lifecycle/failure/concurrency behavior, reuses the existing executable installed-package example and links the structural ownership contract without claiming Runtime ownership compliance.Full COPY-Docker packed acceptance passes, including the reusable example, 64 MiB node/edge streaming, concurrency, checkpoint/fork retention, receipts, negative outcomes and atomic descriptor admission. Normal all-Docker pre-push passes all static/Mermaid/type gates and 8,298 stable unit tests, with two existing skips; 761 files pass and one is skipped. Final package payload is within its existing limits (742,654 compressed bytes, 3,245,331 unpacked bytes, 968 entries).
The initial packed probe found shipped migration links escaping the package payload; a separate focused commit pins those references to exact source commits and the final full gate passes. No runtime/example/harness changes or release are included. Independent review, main-targeted current-head CI after the real prerequisite integrates, and main integration remain open; the issue stays active.
1. Background Context
Source: git-warp #904. Audited against main
94b40dac64034cd8caab9bb05efe14a0c22bd735. Template:feature; work type:type:docs.Current scope and disposition: Mixed timing: current honesty corrections can land immediately, but completion includes real restored examples and agreed structural-ownership distinctions. This is a completion blocker, not a ban on starting docs.
Discussion evidence, including corrections:
2. Problem Description
Mixed timing: current honesty corrections can land immediately, but completion includes real restored examples and agreed structural-ownership distinctions. This is a completion blocker, not a ban on starting docs.
Historical source report; the current disposition above supersedes obsolete claims:
docs/topics/content-and-cas.md directs consumers to public content read surfaces, while the v19 intent API has no content attachment operations (#901). Internal implementation capability is being presented without an executable supported-package route.
2b. Proposed Solution
Mixed timing: current honesty corrections can land immediately, but completion includes real restored examples and agreed structural-ownership distinctions. This is a completion blocker, not a ban on starting docs.
2c. Alternatives considered and rejected
No additional alternatives are recorded as decided. Reject duplicate ownership, private-import escape hatches and a broken intermediate mainline; retain original alternatives below when present.
2d. Acceptance Criteria
Use current topic and migration documentation. Do not revive retired design packets or duplicate the API implementation in #901.
2e. Test Plan
Golden: Attach, replace, clear and stream node/edge content through supported package imports.
Edges: Missing owners/handles, size boundaries, history and concurrent updates.
Known failure modes: Staging failure, missing capability, truncation and cancellation publish no partial result.
Fuzz and stress: Generated large payloads, slow consumers and recursive cycles where in scope, under a Docker heap cap.
All tests and benchmarks execute in COPY-based Docker containers without host repository or Git-directory mounts. This planning audit does not claim those checks were run.
3. Prerequisites
Completion prerequisites; preparatory work may start earlier.
accepted-ownership.4. Scope
In: Mixed timing: current honesty corrections can land immediately, but completion includes real restored examples and agreed structural-ownership distinctions. This is a completion blocker, not a ban on starting docs.
Out: unrelated domain work and any expansion beyond the issue’s stated observable outcome.
Safe intermediate state: the PR builds and passes relevant checks after its listed prerequisites; existing supported behavior remains usable. Any preparatory step must be independently mergeable.
Domain review, 2026-10-01 — accepted ownership / scope correction:
Publish and execute the supported-package examples owned by #902. Current-capability honesty corrections may land immediately; full completion includes the verified restored examples and #903 structural-ownership distinctions.
5. Why now
Maintainer ordering: memory correctness first, supported attachments next, then land eligible PRs. Preserve this card’s existing priority unless a separately recorded scope decision changes it.
6. Risks
Main risk: implementing the historical description instead of the current runtime contract. Preserve compatibility, causal/ownership invariants and bounded behavior relevant to attachments.
7. Definition of Done
The issue-specific acceptance checks pass, relevant validation evidence is attached, and the issue links the coherent PR and resulting mainline integration commit. No open item is hidden in a later repair PR.
8. Stakeholders
James Ross: maintainer, assignee and acceptance owner. Public API consumers rely on reachable node/edge attachment operations and honest ownership.
9. Related Issues
No additional downstream blocker is established. Shared domain membership alone is not a prerequisite.
Historical paths, counts, release names and shell examples in source material are evidence to reconcile, not authority to restore retired documentation or run host tests.