Configuration

Connect a GitHub repository

View as Markdown

Connect the Fern Dashboard to the GitHub repository containing your Fern documentation. Once connected, your docs automatically deploy when you push changes.

To complete the repo connection, you need:

  • Admin access to the GitHub organization where the repository exists
  • The Fern GitHub app installed on the repository

Setup

1

Open the Dashboard

Navigate to the Fern Dashboard and select your documentation site.

2

Connect your repository

In the Source section of the Overview tab, select Connect repo and follow the prompts to authorize the Fern API GitHub app.

3

Install the GitHub app

If you haven’t already installed the Fern GitHub app, you’ll be prompted to install it on your repository. You must be an admin on the GitHub organization to complete this step.

4

Select your repository

Choose the repository containing your Fern documentation. Once connected, Fern automatically deploys your documentation when you push changes to the configured branch.