Automatic documentation suggestions

Learn how GitBook Agent works in the background to keep your documentation up-to-date

This feature is currently in early access

Head to Organization Settings → Docs Agent to request access.

GitBook Agent works in the background of your GitBook organization, consuming ingested data from connected sources to continuously update and refine your documentation.

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. You can also add custom instructions for your docs agent to follow in your docs agent’s settings.

1

Connect a source

To allow GitBook Agent to suggest automatic docs improvements, you’ll first need to connect a source.

After you connect one or more sources, GitBook Agent will start working in the background to collect and analyze your data.

2

Explore how GitBook Agent analyzes your data

After connecting a source, GitBook Agent will categorize conversations, context, and more 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 the data explorer tab in your docs agent’s settings.

3

Review change requests made by GitBook Agent

As more data flow in, GitBook Agent will have enough context to start making suggestions. Suggestions are made in the form of change requests.

Change requests opened by GitBook Agent can be edited like a normal change request, and can be reviewed by anyone on your team with the right permissions.

You can also request a review from GitBook Agent to have it analyze the changes it has suggested.

4

Collaborate with GitBook Agent on changes

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.

Add or remove published sites for GitBook Agent to modify

By default, GitBook Agent will have access to create change requests in any of your published docs. In your docs agent’s settings, you’re able to toggle on/off the sites you’d like your docs agent to have access to.

Add custom instructions for GitBook Agent

To add more custom instructions for your docs agent to follow, head to your docs agent in your organization’s settings, and head to your docs agent’s settings page.

From here you’re able to write custom instructions your docs agent will use any time it’s preparing, analyzing, and generating change requests for your docs sites.