Reviewing & applying suggestions

Suggestions land in your inbox. Review the diff, apply what you trust, and discard what is not relevant.

The review flow

sequenceDiagram
    participant Dev as Developer
    participant Git as Git provider
    participant DW as DocuWriter
    participant Inbox as Autopilot Inbox

    Dev->>Git: Push or open PR
    Git-->>DW: Repository event
    DW->>DW: Check changed code
    DW->>Inbox: Suggestions ready
    Dev->>Inbox: Open suggestion
    Inbox-->>Dev: Side-by-side diff
    alt Looks good
        Dev->>DW: Apply
        DW->>DW: Update page and record activity
    else Not relevant
        Dev->>DW: Discard
    end

What you see on each suggestion

  • Target page in your Space
  • Why it changed: short summary of what changed in the code
  • Diff: current content and suggested content
  • Confidence score: how sure the AI is about the match

Apply individually, or use Apply all or Discard all for fast review on small batches.

Review suggestions with the Platform AI Agent

You can ask the Platform AI Agent to help with Autopilot suggestions.

Examples:

  • "Show pending suggestions for this space"
  • "Which suggestions mention authentication?"
  • "Help me understand this suggestion"
  • "Apply the billing API suggestion"

When you ask the assistant to apply a suggestion, it prepares the action for review. The suggestion is not applied until you confirm it.

For more detail, see Agent actions and approvals.

Preview mode and paid actions

You can review and diff suggestions in preview mode. Apply is locked on plans that do not include applying Autopilot suggestions. Clicking it shows an upgrade prompt.

Preview mode is capped at 50 suggestions per day. Anything past the cap arrives in a daily digest email.

Applying suggestions and auto-apply require a plan that includes those actions.

Auto-apply

Auto-apply is available on plans that include it.

flowchart LR
    Suggestion[New suggestion] --> Score{Confidence<br/>>= threshold?}
    Score -->|Yes| Snap[Save current page]
    Snap --> Apply[Auto-apply]
    Apply --> Log[Activity entry]
    Score -->|No| Inbox[Wait for manual review]
  • Set the confidence threshold per repository link.
  • A copy of the current page is saved before every auto-apply.
  • Every action is recorded in the activity history.
  • Rollback and history options depend on your plan and available Space activity surfaces.

PR comments

When PR comments are enabled and a repository event includes a pull request number, DocuWriter.ai can post a Markdown comment on the pull request.

The comment includes:

  • A summary of the suggested documentation updates
  • Links to apply individual suggestions

GitHub supports open pull request updates. Other providers may trigger primarily on merged or fulfilled pull request events, depending on the provider event available to DocuWriter.ai.

Activity and sync events

Not every repository event produces suggestions. Use the Activity tab to view Timeline and Audit Log entries such as:

  • Running syncs
  • Suggestions created
  • No suggestions found
  • Failed syncs
  • Applied suggestions
  • Discarded suggestions
  • Settings changes

Troubleshooting

Issue What to check
No suggestions after pushing Check that the repository link is enabled, the branch name matches, and the provider connection is still active.
Apply is locked Your plan may only include preview mode. Upgrade to a plan that includes applying suggestions.
Daily limit reached Preview suggestions are capped. Check the daily digest email for the remaining suggestions.
Expected pages were not suggested Check path filters and confirm the changed files are relevant to documentation.
Suggestions are paused Check credits, repository connection status, and plan access.
The assistant cannot find suggestions Make sure you are asking about the correct Space and that you have permission to manage it.
PR comments do not appear Check that PR comments are enabled, the provider connection is active, and the repository event includes a pull request number.

Next