Update and review

Use update mode when documentation exists but needs changes. Use review mode to get feedback without modifying content.

Update from tickets

When a feature ships or a bug is fixed, update documentation by referencing the ticket. The agent reads the ticket details and identifies which docs need changes.

Works with: Linear, Jira

Basic update

Update the documentation based on Linear ticket ENG-1234.

With context

ENG-1234 added rate limiting to the API. Update the
API reference with the new rate limit headers and
error responses.

Multiple tickets

Update the authentication docs based on ENG-1234,
ENG-1235, and ENG-1236.

Tip

Adding context about what changed helps the agent make more accurate updates.

Update from code changes

Point the agent to code changes and it updates relevant documentation.

The login flow changed in the last commit. Update the
authentication guide to reflect the new OAuth
implementation in src/auth/.

We deprecated the /api/v1/users endpoint. Update the
API reference to mark it as deprecated and point to
the v2 replacement.

Update specific sections

Target specific parts of a document instead of regenerating everything.

Update only the "Configuration" section in
docs/getting-started.md with the new environment
variables from .env.example.

Add a "Troubleshooting" section to the deployment guide
covering the three most common issues from our support
tickets.

This is useful when you want precise edits without affecting the rest of the document.

Review documentation

Get AI feedback on existing documentation without making changes. The agent analyzes your content and provides suggestions.

What the agent checks

Aspect	What it looks for
Clarity	Are instructions easy to follow? Is the language clear?
Completeness	Are steps missing? Are edge cases covered?
Accuracy	Does the documentation match the current code?
Consistency	Does terminology match other docs? Is formatting consistent?

Example prompts

Review the getting started guide and suggest improvements
for clarity and completeness.

Review the API reference for the authentication endpoints.
Check if the examples still work with the current code.

Review docs/deployment.md from the perspective of a
developer who has never deployed this application before.

Applying suggestions

The agent provides feedback in the chat panel. You can:

1. Apply suggestions you agree with by asking the agent to make the change
2. Edit directly in the editor panel
3. Iterate by asking for more specific feedback

Verify before publishing

View changes

Click View Changes in the toolbar to see a diff of all modifications. Review each change before creating a pull request.

Look for:

• Unintended deletions.
• Formatting issues.
• Content that needs adjustment.

Link validation

The agent automatically validates links and email addresses in generated content. If it detects broken links, it regenerates the affected sections with corrections.

Create a pull request

When satisfied with the changes:

1. Click Raise PR in the toolbar.
2. Enter a title and description.
3. Select the target repository if changes span many repos.
4. Click Create.

The pull request opens on GitHub where your team can continue the review process.