SSowle

How proposals work

A proposal is a knowledge pull request. It holds the proposed Markdown, a reason, discussion, and a status. Merging it creates the next official version of the document. This is the product. The rest of Sowle exists to make this path boring and reliable.

  1. Step 1

    Open a proposal from a document

    Propose change starts from the current version. You edit the text, write a title, and say why. You can assign a reviewer. Editors and admins can do this. Viewers cannot.

  2. Step 2

    Discuss on the proposal

    Comments stay attached to the change, not a side thread. Anyone in the workspace can comment, including viewers.

  3. Step 3

    Approve

    One approval from an admin or the assigned reviewer. Authors cannot approve their own proposal. After approval, status becomes Approved.

  4. Step 4

    Merge

    Merge writes a new version and points the document at it. Admins can always merge, including before approval. Editors can merge once the proposal is approved.

Statuses
  • OpenWaiting on review or discussion.
  • ApprovedHas the required approval. Ready to merge.
  • MergedBecame an official version. The document moved forward.
  • ClosedAbandoned. The official document did not change.

Protected vs quick edit

Protected documents hide Quick edit. The only path is a proposal. Unprotected documents still version every quick edit. If a doc should not change under pressure, protect it.