What is GitBook Agent?

GitBook Agent is an AI teammate that works alongside you. It helps you keep your documentation accurate, complete, and current. GitBook Agent is deeply integrated into GitBook. You don’t need new workflows to use it.

What can GitBook Agent do?

GitBook Agent can:

• Write docs based on a prompt: Ask GitBook Agent to update a page, rename a product, or make any other change you need.

• Import content into GitBook: Attach files like PDFs and Microsoft Word documents in the GitBook Agent chat sidebar. GitBook Agent extracts and formats the content into pages in your space.

• Plan and implement bigger changes: Describe what you need. GitBook Agent opens a change request, explains its edits, responds to feedback, and implements the plan you create together.

• Follow your styleguide: Define your team's writing rules in a styleguide , and GitBook Agent treats it as the source of truth when writing or reviewing content.

• Follow custom, site-level instructions: Give GitBook Agent site-specific instructions, such as how to add links or which block types to avoid.

• Translate your documentation: Choose the content you want to translate, select a language, and GitBook Agent localizes your docs.

• Summon from a comment: Add a comment to any block on your page, type @gitbook, and tell GitBook Agent what you need.

• Review change requests: Add GitBook Agent as a reviewer on your change request. It can act as a docs linter, flag style guide issues, and suggest or fix errors.

Automatic documentation suggestions

GitBook Agent can also connect to the signals your team uses to understand your product and your customers’ needs: support conversations, tickets, and threads from your connected tools.

With this context, GitBook Agent can identify gaps, propose updates, and generate docs changes automatically.

As your docs evolve with your product, your customers get the right information when they need it.

Explore GitBook Agent’s features

Add a style guide and custom instructions

You can configure GitBook Agent with your team’s style guide or site-specific instructions.

GitBook Agent uses this context whenever it creates or edits content for that site.

To add a style guide or custom instructions, open your site’s Settings and choose the Agents tab. Add your instructions in the custom instructions field.

You can also open this screen from a change request. Open the GitBook Agent chat window, then open the Actions menu and choose Configure GitBook Agent .

Custom instructions example

Here’s an example of the custom instructions you can add in GitBook Agent’s settings.

FAQs