6.6 KiB
navigation
| navigation | ||||||
|---|---|---|---|---|---|---|
|
Documents, attachments, and work products
People read and revise task documents, annotate specific content, open attached files, and inspect the outputs an agent hands back. The artifact library provides another route to the same work.
Feature ID: documents-artifacts.
Implementation: task documents, artifact library, document panel.
Agent access: companion.
Sub-features
documents:documents-artifacts/documents— edit versioned task documents and inspect or restore revisions.annotations:documents-artifacts/annotations— attach feedback to document content and inspect resolution state.attachments:documents-artifacts/attachments— upload, preview, and download allowed files with company access checks.work-products:documents-artifacts/work-products— link deliverables to their source task, resource, and review context.library:documents-artifacts/library— search, filter, group, and open artifact stacks.
How to get to it (user POV)
task-document
Open a document from the task thread or document side panel.
Coordinator decision receipts also open a pinned reviewed revision alongside the matching task interaction. Historical tabs retain their revision identity independently of the current document tab. Missing revisions are explicit and never silently replaced with the latest document. When a decision in one task reviews another task's document, the center pane keeps the originating conversation while the sidebar opens the document owner's exact revision. An inaccessible owner never falls back to the origin task's document.
task-output
Open an attachment, output card, or file link from a task. For direct uploads, use the task side panel's Open a new tab → Artifacts → Upload files or drop files anywhere in that panel. On mobile, open More actions → Properties first. Agent conversations do not expose this upload path.
artifact-library
Open /artifacts and its grouping, search, and media controls.
Driving it with Playwright and the Paperclip CLI
Preconditions: follow the baseline. Use a task with a text document, a small attachment, and a generated work product. Use nonsensitive fixture files.
task-document
Automated: documents service, annotations, and revision restore cover server contracts.
Exact revision panel checks pinned content and missing-revision behavior; this component test does not prove end-to-end conversation scrolling. Open a resolved receipt after making a new revision and verify the earlier body plus matching interaction in the browser.
Manual: Edit a paragraph, save, reload, and compare revisions. Add an annotation to a specific selection and inspect it after another edit. Resolve it through the supported action. Restore a disposable revision and confirm the new current document and history agree.
task-output
Automated: attachment routes and work products cover data/access behavior; artifact arrival browser suite targets arrival. Artifact uploads drives file selection/drop, filename collisions, retry, and preservation of paused/unassigned tasks.
Manual: Upload a small Markdown file and CSV through Artifacts. Markdown becomes a versioned task document; other files become attachments. Read the document, download the CSV and compare bytes, then reload. Upload the same Markdown filename again and verify a separate suffixed document without overwriting the original. On a paused unassigned task, confirm upload does not start work or add comments. Verify agent-produced work products separately using an eligible test run. Test an inaccessible user/company and explicit missing workspace-only resources.
artifact-library
Automated: artifact page covers grouping, search requests, and pagination using mocks.
Manual: Find the task’s output through search and grouping, open its stack, page through results, and reload a direct stack link. Confirm the same file/content appears as from the task.
Gotchas
-
In Coordinator, saved plan cards use document chronology, so a plan written before its output appears first even when both writes share one native run. Authored issue-document links use the same compact sidebar-link surface and retain revision/annotation targets. Classic run embedding is unchanged. The UI does not remove or deduplicate canonical plan content.
-
A local path is not automatically an uploaded artifact accessible to another user.
-
A preview screenshot is not proof that download bytes or revision references are correct.
-
Version conflicts and stale annotations must stay visible rather than silently targeting different content.
Storybook verification
documents
Capability ID: documents-artifacts/documents.
Scope: ui Storybook: Writable/read-only document, save pending/failure/conflict, revision history/historical preview and restore confirmation. Production: Persist edited body and reload; append-only restore creates new revision; reject stale writes and inaccessible company/task. Sources: Source: IssueDocumentsSection.tsx, TaskDocumentPanel.tsx, documents.ts. Tests: IssueDocumentsSection.test.tsx, document-revisions.test.ts, documents-service.test.ts, issue-document-restore-routes.test.ts
Documentation scope: Artifacts and work products
Document/attachment/library/work-product journeys are mapped; every media preview type, storage backend, annotation conflict, and runtime-resource lifecycle variant remains separate.