Sheaf
SheafDocsFiling and documentsDocuments in edit

Documents in edit

When the run suggests merging a document with another, or splitting it, the document is in edit until someone decides. Filing it asks first.

A run sometimes reads one document as two, or two documents as one. It says so as a suggestion.

  • Merge. Two documents the run filed under the same requirement, when that requirement expects a single document. Example: pp. 8–9 and pp. 10–12 of one closing disclosure, both suggested for "Closing Disclosure".
  • Split. One document the run read as several. Example: a 4-page range that holds two bank statements.

A requirement that expects sets never gets a merge suggestion: it expects many documents.

Until someone decides, the document carries the in edit tag.

Resolving it in Doc Review

Doc Review is where suggestions are resolved.

  • A merge shows between the two cards on the strip: Merge if they are one document, Dismiss if they are separate.
  • A split shows on the card: split it, or keep it as one.

The rail names the suggestion, and Approve waits until it is resolved:

The rail naming an open merge suggestion

Filing a document in edit from anywhere else

Approve, or any choice in ⋯, asks first:

A merge was suggested with balloon-rider.pdf (pp. 40–41).
Continue? Confirm match keeps it as it is and files it.
Doc Review is where the suggestion is resolved.

                     Cancel    Open in Doc Review    Confirm match
  • Open in Doc Review opens the room on the document's first page.
  • Confirm match records the suggestion as dismissed, then records your decision. The ledger has both: merge.dismissed or split.dismissed, then the decision.
  • Cancel records nothing.

Over the API

GET /applications/{id}/documents marks the document with inEdit: the suggestion, and for a merge the other side's pages. Filing it is refused with a 409 until the suggestion is resolved or dismissed:

In edit: a merge was suggested — resolve it in Doc Review, or dismiss it first

To dismiss, send decision: "dismissed" to POST /applications/{id}/merge-resolutions or POST /applications/{id}/split-resolutions.

A workflow is not held back by an open suggestion. It files what it recommended.

This page as markdown · llms.txt · API contract