Today we're announcing three new editing features: page comments, a new look for the review tab, and a beta of the AI Reviewer.
Your team can now discuss changes directly on relevant text or components, right in the editor or on changes in the branch Review tab. The AI Reviewer takes part in the same threads. Request a review and it checks every page your branch modifies against your project Linter rules, then leaves findings as comments on the text.
Comment where you write
Highlight any text in the editor and click Comment, or use the ≡ icon beside any block to comment on a whole image, code sample, or callout. Type @ to mention a teammate, and they'll receive a notification with a direct link to your comment. Comments support bold, italics, inline code, and links, so you can drop suggestions straight into the thread.
Comments are for your team only. They aren't committed to git, and readers of your docs never see them. Each comment belongs to the branch or version where you left it, and merging a branch will resolve its open comments.
Multiplayer editing keeps everyone in sync on the same page. When a teammate replies to or resolves a thread, you'll see it without reloading, along with their edits as they type. If someone deletes the text a comment is on, the comment stays in the Comments panel with an Outdated label, so the discussion isn't lost. Filter the panel to show Open, Outdated, or Resolved comments.
Leave feedback in a review
Comments work in the Review tab too. Select text in the diff to comment on it, or use Leave a comment... at the bottom of the new Review Overview to leave feedback on the whole branch. By default every teammate can comment on a review, Viewers included, so people who can't edit the docs directly can still weigh in before a change goes live.
The Overview now also includes a concise generated summary of what's changed in the branch. Below it, the Activity feed lists every review event and comment thread in chronological order. Within comments, you can select the page path above a thread to view it in the diff.
Get a first pass from the AI Reviewer
Currently in beta, the AI Reviewer reads each page your branch touches and checks it against the Error and Warning rules you've set up in the Linter. Each finding becomes a comment from the AI Reviewer, anchored to the exact violating words or block. Its comments sit in the same threads and panel as your teammates' feedback, and you can reply to and resolve them the same way.
The AI Reviewer will run automatically when you click Request Review. If your branch is still a draft, click Request on the AI Reviewer row under Reviewers. After updates are made on the branch, click the refresh icon on that row to review the latest changes.
Every run includes context from the branch's existing comment threads, including comments left by teammates and from earlier AI reviews. The AI Reviewer uses them to decide which findings to raise again, so a finding your team already resolved or explained in a reply doesn't keep coming back.
To act on a finding, click Fix on its comment and send the finding to the Agent for resolution. Fix All on the AI Reviewer's activity entry sends every finding from that review at once.
Who can comment and what holds a merge
On Enterprise projects, Group Admins can set permissions for comments and the AI Reviewer from the Projects table. For commenting, choose which teammate roles can leave or resolve comments. Even if restricted from writing comments, all team members will still be able to read comments left on your docs, and Editors can still click Fix on any AI Reviewer comment.
Within the Branch Rules section, the Reviewer Approval section has been expanded to allow AI Reviewer approval to count. Turning on Dismiss Stale Approvals requires re-approval when the branch is updated. No Blocking Comments enables selected teammate roles and/or the AI Reviewer to block a merge until certain comments are resolved. Each AI Reviewer option turns on by default when you enable Reviewer Approval or No Blocking Comments.
If a project already requires zero lint errors, we've turned on No Blocking Comments so the AI Reviewer's error comments block merges. Admins can still bypass any requirement with Skip Requirements & Merge. See Reviews for every branch rule in detail, and if you don't have Enterprise yet, book a demo.
Get started
Comments and the AI Reviewer beta are available on Pro plans and above.
To try them out:
- Open a page in the editor, select some text, and click Comment.
- Add Error and Warning rules under AI > Linter in your project's Admin Tools.
- Create a branch, make a change, and click Request Review in the Review tab.
The comments guide and the AI Reviewer guide have the full details for each new feature. All feedback can be sent to support@readme.io.