Skip to main content

Sync content from GitHub

Sync Markdown files from a GitHub repository into Fin so Fin and Copilot can use them.

GitHub content sync lets you sync Markdown (.md) files from a GitHub repository into Fin, so Fin and Copilot can use them.


Getting started

  1. Go to Train > Content, click See all, then choose From GitHub.

  2. Install the Fin GitHub sync app for the GitHub account you want to connect. You may need approval from your organization admin to install the app on an organization account.

  3. Choose whether the app can access all repositories or only selected ones.

  4. When the GitHub setup is done, the pop-up window closes. Pick the repository, and a folder if needed, that you want to sync Markdown files from.

  5. (Optional) Choose to create or update a CLAUDE.md file with instructions for Claude Code on how to create and update synced content and use the Frontmatter schema.

  6. Click Clone and connect.

Note: To give access to a different repository later, click Manage GitHub repository access on GitHub. This opens the same pop-up window, where you can add repositories to the allow-list.


Permissions

The Fin GitHub sync app needs these GitHub permissions:

  • Metadata (read only): The default scope every GitHub app has.

  • Checks (read and write): Runs the Frontmatter schema checks described in PR checks below.

  • Code (read and write): Creates or updates the CLAUDE.md file. Creating the file is optional, but the permission is required.

  • Pull requests (read and write): Creates the CLAUDE.md file and receives the webhooks that sync changes to Fin and run PR checks.

  • Workflows (read and write): Adds the GitHub Actions workflow that lets your repository auto-approve and merge Fin’s suggestion pull requests (optional auto-merge setup).


How syncing works

When you first connect your repository, Fin syncs all Markdown files in it, or in the folder you chose. After that, when a change to those Markdown files is merged, Fin applies the edits automatically.


(Optional) Frontmatter schema

Frontmatter isn’t required. If your Markdown files don’t already use it, you can skip this section. Frontmatter lets you set extra properties for how each file is synced into Fin. Add it to the top of your Markdown file, like this:

---
title: How to request a refund
description: Steps to get a refund on your order
audience: everyone
published: true
fin: enabled
copilot: enabled
sales_agent: disabled
---

Article body goes here…

Supported keys and values:

  • title (any text): The article title. If it’s missing, Fin uses the first H1, or a readable version of the file name.

  • description (any text): A short description shown under the article title.

  • published or state (published, true, draft or false): Whether the article syncs as published or as a draft. Published means the content is live and available to Fin.

  • public_url (any URL): The public URL customers are sent to when Fin cites this content. Without it, Fin doesn’t cite a source for the article.

  • service_agent or service (enabled or disabled): Whether Fin can use the article.

  • copilot (enabled or disabled): Whether Copilot can use the article.

  • sales_agent or sales (enabled or disabled): Whether Sales Agent can use the article.

All Frontmatter keys and values are optional. Unrecognized keys are skipped.


PR checks

Fin runs lightweight checks on pull requests that change your synced Markdown files. They check that every Frontmatter key is valid and supported. A failed check shows in the checks section of the pull request, and you can click it for details.

Note: These checks don’t block merging. Pull requests can still be merged if the GitSync: Content Validation checks fail. To enforce them, see GitHub’s guide to requiring status checks before merging.


Known limitations

  • Only Markdown (.md) files are synced. .mdx files aren’t supported yet.

  • Synced articles are turned off for Fin, Copilot and Sales Agent by default, so you can review them before setting them live.

  • This is a one-way sync from GitHub to Fin. Synced articles are read-only in Fin and must be edited in GitHub.

  • Articles are currently only created in English.


💡Tip

Need more help? Get support from our Community Forum
Find answers and get help from Intercom Support and Community Experts


Did this answer your question?