Automatic documentation suggestions
Learn how GitBook Agent works in the background to keep your documentation up-to-date
Last updated
Was this helpful?
🇺🇸 English
Learn how GitBook Agent works in the background to keep your documentation up-to-date
Last updated
Was this helpful?
Was this helpful?
Head to Organization Settings → GitBook Agent to request access.
GitBook Agent can connect to the same signals your team uses to understand both your product and what your users need: support conversations, Slack threads, GitHub issues, and more.
With this context, the Agent can proactively identify gaps, propose updates and generate docs changes automatically.
GitBook Agent is trained on your organization’s content, meaning it has the context of your team’s writing style, structure, and tone-of-voice. And you can add custom instructions for the Agent to follow — more on that below.
To allow GitBook Agent to suggest automatic docs improvements, you’ll first need to connect a source.
After you connect one or more sources, the Agent will start working in the background to collect and analyze your data.
After connecting a source, GitBook Agent will categorize that contextual information into conversations, issues, and topics.
It uses these in combination to suggest automatic improvements to your docs, which are opened as change requests.
To review the data GitBook Agent analyzes, head to your organization’s settings, then open the Data explorer tab in the GitBook Agent section.
As more data flows in, GitBook Agent will have enough context to start making suggestions — by opening new change requests in the relevant spaces.
You can edit change requests opened by GitBook Agent just like any other change request — and anyone on your team can review them, as long as they have the right permissions.
You can also request a review from GitBook Agent to have it analyze the changes it has suggested.
GitBook Agent can also act as a writing partner, allowing you to plan, write, re-write, or update anything within a change request.
When reviewing a change request from the change requests screen, opening GitBook Agent will allow you to chat with it directly to make changes in the context of the change request you’re working on.
You can also add comments to specific blocks, and tag @gitbook to ask GitBook Agent to make a change.
By default, GitBook Agent will have access to create change requests in any of your published docs sites. In the GitBook Agent’s settings screen, you can choose which sites to which you’d like the Agent to make suggested changes.
To add custom instructions for GitBook Agent to follow, open your organization’s settings and choose the GitBook Agent page in the sidebar.
From here you’re able to write custom instructions the Agent will use any time it’s preparing, analyzing, and generating change requests for your docs sites.