Documentation Agent
Custom DeploymentOverview
The Documentation Agent monitors your GitHub repository for merged pull requests and automatically updates affected documentation pages. It reads the diff, identifies which sections of your docs are impacted, and opens a targeted PR with the corrected content — keeping your documentation perpetually in sync with the product without requiring manual effort from engineers or technical writers.
The result is documentation that stays accurate as the product evolves, with a full audit trail of every change linked back to the originating PR.
How to deploy
Connect the agent to your GitHub repository via the Oz GitHub integration. Configure your documentation source — a docs/ folder in the same repo, a separate documentation repository, or a hosted platform like Mintlify or GitBook.
Define which file paths trigger documentation updates and set your preferred review workflow: the agent can open PRs for human review, or merge directly to a staging branch when confidence is high. A configurable confidence threshold lets you dial between fully autonomous and human-in-the-loop modes.
Integrations
GitHub for PR monitoring and documentation pull requests, Mintlify and GitBook for hosted documentation platforms, Notion for wiki-style documentation, Slack for PR review notifications.
Linear and Jira integration lets the agent create tickets for documentation gaps it discovers but cannot fully resolve automatically.