- Researches: Reads your existing documentation repository to understand the file structure, format, and conventions.
- Locates: Finds the right files to update — or determines where a new article should live.
- Writes: Generates or updates content matching your existing tone and style.
- Creates a PR: Opens a pull request with proposed changes for review.
KB Gap Detection requires a connected GitHub integration. To create real pull requests, install the GitHub Write app from your Integrations page. With only the standard read-only app, the agent runs in preview mode and shows proposed changes without creating PRs.
What the agent can do
The agent handles two types of documentation changes:- Create new articles when a support topic has no existing coverage in your docs. The agent creates a new file matching your repo’s format and conventions, and updates the navigation config (e.g.
docs.json,mint.json) so the page appears in the sidebar. - Update existing articles when your docs cover a topic but are missing details. The agent makes surgical edits to the relevant files — adding only the missing content without reformatting surrounding text.
.md, .mdx, .rst, and .json files. It cannot modify code files or other non-documentation content.
How gaps are detected
When the AI agent resolves a support ticket, Decimal analyzes the resolution against your existing knowledge base. If the agent had to explain something that isn’t documented — or found that existing docs were incomplete — that’s flagged as a gap. Gaps are only acted on when confidence is high. If the analysis is uncertain, or the resolution doesn’t clearly point to missing documentation, no changes are proposed.Triggering the agent
From a ticket
- Open a resolved ticket on the Support page
- Click KB Gap in the actions panel
- The agent runs in the background — results are delivered via Slack notification
Action modes
You can control what happens after the agent drafts its changes:| Mode | Behavior |
|---|---|
| Notify internal (default) | Preview mode. Proposed diffs are included in the Slack notification for your team to review. No PR is created. |
| Notify external | Preview mode. An internal note with the proposed changes is posted to the ticket in your ticketing system (Zendesk, Pylon, etc.). |
| Full write | Creates a pull request on your docs repository. Requires the GitHub Write app. |
Reviewing pull requests
PRs created by the agent follow your normal review workflow:- PR title uses a Conventional Commits prefix (e.g.
docs: add rate limiting documentation) - PR body includes a summary of what changed, the support context that revealed the gap, and a link back to the source ticket
- Requested reviewers can be configured for your organization so the right people are notified
Customize the agent’s writing
Style guide
If your documentation follows specific writing conventions, you can provide a style guide in your repository. When configured, the agent reads the style guide before writing so that generated content matches your terminology, formatting, and tone. Contact support to configure your style guide path.Matching existing conventions
Even without a style guide, the agent reads existing files in your repository before writing. It matches:- Frontmatter format and fields
- Heading style and hierarchy
- File extensions (
.mdxvs.md) - Directory structure and naming patterns
- Navigation config format (Mintlify, Docusaurus, Fern, etc.)
Safeguards
The agent includes several safeguards to keep your repository clean:- Confidence threshold — Changes are only drafted when the gap analysis is highly confident. Low-confidence gaps are reported but not acted on.
- Duplicate detection — Before creating a PR, Decimal checks if an existing open PR already covers the same gap. If one exists, it links to it instead of creating a duplicate.
- Rate limiting — A maximum number of PRs can be created per organization in a rolling 24-hour window to prevent flooding your repository with open PRs.
- File restrictions — Only documentation files can be created or modified. The agent cannot touch code, configs outside navigation files, or binary assets.
- Read-only fallback — If the GitHub Write app isn’t installed, the agent automatically runs in preview mode instead of failing.
- Content rules — The agent will not publish internal implementation details, secrets, or sensitive information. If the proposed content violates these rules, no PR is created.
Connect the GitHub Write app
The standard GitHub integration gives Decimal read access to your repositories for code search during ticket investigation. To enable the agent to create pull requests, install the GitHub Write app:- Go to Integrations in the sidebar
- Click GitHub Write and follow the authorization flow
- Select which repositories the agent can write to