Skip to content

Add documentation for connecting a GitHub repository in the dashboard #3348

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devalog merged 2 commits into from
Jan 30, 2026
+41 −0
Merged

Add documentation for connecting a GitHub repository in the dashboard #3348

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15ac3a1
fern-api[bot] Jan 29, 2026
e65c7ab
correct ui language
devalog Jan 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions fern/products/dashboard/dashboard.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ navigation:
- page: Member permissions
path: ./pages/permissions.mdx
slug: permissions
- page: Connect a GitHub repository
path: ./pages/github-repo.mdx
slug: github-repo
- page: Set up SSO
path: ./pages/sso.mdx
slug: sso
Expand Down
37 changes: 37 additions & 0 deletions fern/products/dashboard/pages/github-repo.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Connect a GitHub repository
description: Link your GitHub repository to your Fern project for automated deployments.
---

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](https://github.com/apps/fern-api) installed on the repository

## Setup

<Steps>
<Step title="Open the Dashboard">

Navigate to the [Fern Dashboard](https://dashboard.buildwithfern.com/) and select your documentation site.
</Step>

<Step title="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.

</Step>

<Step title="Install the GitHub app">

If you haven't already installed the [Fern GitHub app](https://github.com/apps/fern-api), you'll be prompted to install it on your repository. You must be an admin on the GitHub organization to complete this step.

</Step>

<Step title="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.
</Step>
</Steps>
1 change: 1 addition & 0 deletions fern/products/dashboard/pages/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Visit your team's [Dashboard](https://dashboard.buildwithfern.com/) and complete
<Card
title="Integrate GitHub"
icon="brands github"
href="/learn/dashboard/configuration/github-repo"
>
Connect your GitHub repository to your project.
</Card>
Expand Down
Loading