Versions and the working copy
Every document has a working copy, which is what you see and edit, and a list of saved versions, numbered v1, v2 and so on. A version is a fixed snapshot. Reviews, approvals and share links point at versions, never at the working copy.
A new version is saved when:
- an agent publishes or republishes a document,
- anyone submits it for review, or
- someone with edit rights chooses Save a version… from the ⋯ menu or the version menu.
Saving a version doesn't ask anyone to review it. Edits in the editor and targeted edits by an agent change the working copy only. If nothing changed since the last version, no new one is saved.
The version menu
Next to the document type at the top of the page, a menu shows "vN of M". Open it to see every version with its summary, its author (a person or the agent's connection) and when it was saved. The approved version is marked Approved. Click a version to compare it, or choose Compare with… to pick any two.
When a new version answers comments on the previous one, a note above the text says so, for example "v3 answers 2 comments on v2", with a link to compare.
Compare versions
The Compare page shows a line-by-line diff between two versions. Pick From and To; either can be the Working copy, so you can see edits that haven't been saved as a version yet. Open it from ⋯ → Compare versions, from the version menu, or from the "Compare with vN" links on the page.
Amendments
Changes after approval are amendments. When someone submits a new version of an approved plan:
- The plan keeps its status, Approved or In progress. A second label shows "vN in review".
- A note explains that the earlier version is approved and the agent keeps working from it, with a link to compare the two.
- Reviewers get a review request titled "Amendment requested".
- The approve button reads Approve amendment. Approving it replaces the approved version, and the agent continues with the amended plan.
- Requesting changes on an amendment leaves the approved plan in force.
To amend a plan yourself, edit it and choose Submit an amendment… from the ⋯ menu.
What the agent sees
When you review, the agent calls get_feedback and receives:
- the document's status, its approved version and its current version,
- your latest review: approve or request changes, your note, the version and who reviewed,
- every unresolved comment, with the text it quoted and whether its block has since been removed,
- the state of every checklist, decision pick and answer,
- the decisions and required questions still open, and whether you approved with items open,
- a diff of what people changed since the agent's own last version.
The agent's instructions tell it to respect your edits, picks and answers, fix what the comments ask, reply to each comment, resolve the ones it handled and submit again. If it republishes the whole document, your picks and answers carry over to the new version.
Agents can also wait for you: wait_for_review returns as soon as someone reviews, comments or edits, or after a timeout. For long reviews the agent stops and picks the document up later.