GitHub Copilot

By GitBook

GitBook Copilot uses your documentation to provide instant answers to your coding workflow.

Install

Overview

GitBook Copilot leverages your organization's documentation to answer team member queries, providing instant and accurate responses based on your content. It integrates seamlessly with GitHub to assist developers while they code, offering relevant knowledge directly within their workflow.

Configure

To configure GitBook Copilot with your GitBook workspace:

Install the GitBook Copilot App to your GitHub organization
Install the GitHub Copilot integration in your GitBook organization
Authenticate your GitHub account:
- Log into your GitHub account, and select the account(s) you would like this integration to work in.
Connect Your Documentation:
- Under spaces, in the integration's configuration, select which spaces you would like GitBook Copilot to leverage information from.

Use-cases & example prompts to get started

The GitBook for GitHub Copilot integration allows your to ask questions and get instant answers based on your documentation. Here are some examples of questions you can ask: Get information about a specific topic:

@gitbook-copilot how do I set up a new project?
@gitbook-copilot what is the best way to deploy my application?

Get help with code:

@gitbook-copilot how do I import components from our design system?
@gitbook-copilot what is the best way to handle an error with a missing variable?

Troubleshoot an issue:

@gitbook-copilot why is my build failing?
@gitbook-copilot how do I fix a broken link in my documentation?

Support

If you need assistance with GitBook Copilot:

Community Support: Engage with other GitBook users in our GitBook Community.
Technical Support: For more complex issues, reach out to our support team via email at support@gitbook.com.