Article states
Changes holds every edit that has not gone out, in three stages. Each article also carries a chip that says what it waits for. Anyone on your team can answer edits, mark an article Ready to Publish, and publish.
Stages on Changes
What waits for a person: proposed edits, drafts Docmunk wrote, comments that mention you or reply to you, and held words the help site changed under. While Docmunk reads your code against the help center, its line says “Checking” and a count.
Articles whose edits wait to go out: in Next publish, in a release group, or typed and not marked Ready to Publish.
Each publish, with its day and who published it. Undo takes back the newest one.
Changes opens on To review while anything waits there, and on Ready to Publish when only that stage holds something.
Article chips
The chip shows beside the title of an open article, and in ⌘K results. A published article with nothing waiting shows no chip.
| Chip | What it means | What moves it on |
|---|---|---|
| “Needs you” | Proposed edits wait for an answer. Docmunk proposes them when your code changes, and the chat proposes them when someone asks. | Answer each edit with Accept or Reject. |
| “New” | The article is not on the help site, and nobody marked it Ready to Publish. Docmunk drafts some; people start others. | In the article, select Mark Ready to Publish or Ready to Publish. Then choose Publish now or Publish later. |
| “Edited” | Someone typed in the article, and nobody marked those words Ready to Publish. | Select Mark Ready to Publish on Ready to Publish, or Ready to Publish in the article. |
| “Ready” | Its edits go out with the next publish. In the article, Ready shows the mark; select it to take the mark off. | On Next publish, select Publish. |
| “Release group:” and a name | Its edits wait for that release group. | The group goes out by itself, or someone publishes it. |
After more typing in a marked article, its button reads Ready to Publish again. The typed words go out only once someone marks them.
Rows on Changes
| Stage | What the row says | What it means |
|---|---|---|
| To review | “New article” | Docmunk drafted this article. Select Review to read it. |
| To review | A count, such as “3 updates” | Proposed edits wait in the article. Select Review. |
| To review | “Drafting” | Docmunk is still writing the article. |
| To review | “mentioned you in” or “replied to you in” | A comment names you, or answers yours. Select Open. |
| To review | Under “Live changed underneath” | Words held for a release group rest on words the help site changed since. Select Compare. |
| Ready to Publish | “· Edited” | Typed words nobody marked. Select Mark Ready to Publish. |
| Ready to Publish | “Live changed underneath” | The help site's words changed under the group's edits. Select Compare on To review. |
| Ready to Publish | “Next publish changes it” | The next publish changes words the group's edits rest on. |
| Published | “Taken back” | Someone selected Undo on this publish. |
Release group chips
On Ready to Publish, Next publish shows “Anytime”: it goes out when someone selects Publish. Each release group shows when it goes out:
| Chip | What it means |
|---|---|
| A date and time, such as “Thu Oct 2 · 9:00 AM” | The group goes out by itself at that time. |
| “Waits on” and a flag | The group waits until the flag is on for everyone. |
| A flag and “is on · needs Publish” | The flag is on. The group goes out when someone selects Publish now in its menu. |
| A flag and “is on” | The flag is on, and the group goes out by itself. |
| “Not scheduled” | The group goes out when someone selects Publish now in its menu. |
| “Created from a new flag” | Docmunk made the group for a flag it found in your code. |
A group that goes out by itself publishes as the person who last set when it goes out. When the help site's words changed under what it holds, it stays back and says “Stayed back when it was due”. It goes out once someone answers those articles on To review. For the steps, see Publish a release group.
How an article moves
- Docmunk checks a change to your code and proposes edits, or someone asks the chat for one. The article shows “Needs you” and waits on To review.
- Someone answers each edit. An accepted edit also marks the article Ready to Publish, unless it holds typed words nobody marked. The article shows “Ready” and waits on Ready to Publish.
- Someone types in the article. It shows “Edited” until someone marks it Ready to Publish.
- Someone publishes Next publish, or the article's release group goes out. The article shows no chip, and the publish shows on Published.
A draft Docmunk writes for a feature starts as “New” on To review. Mark Ready to Publish in the draft asks when it goes out: Publish now, or Publish later with Next publish or a release group. To answer edits, see Review proposed edits. To publish, see Publish articles.