For GitHub repos

Ask AI for your GitHub repo

Connect a GitHub repo once and Biel turns READMEs, docs folders, and code into documentation answers for your customers and your team. Public or private. Auto-sync via GitHub Actions.

Connect GitHub to Biel See setup steps

14-day free trialNo credit card required

acme / sdk-python

What Biel reads

📄 README.md
📁 docs/
📁 src/
📄 CHANGELOG.md

→

Used by documentation and developer-experience teams

What Biel reads from your repo

Index documentation from the repository

Index READMEs, documentation directories, and supported repository content, then test answers against the original documentation.

README files

The first thing a developer reads. Indexed as a primary source so quickstart and install instructions land in answers.

README.md, README.rst

docs/ folder

Index supported Markdown, reStructuredText, and plain-text documentation. Use include and exclude patterns to select the files.

docs/**/*.md

Source code

Include supported text-based documentation and code comments. Filter files so unrelated repository content stays out of the index.

src/**, *.py, *.json

GitHub Pages

If your repo publishes a docs site to *.github.io or a custom domain, point Biel at the live URL and it crawls the rendered HTML. Jekyll, Hugo, MkDocs, any builder.

docs.acme.dev

Setup

Connect the documentation your readers need

Create an account, connect your repo, automate the rest. No code on your side until you want auto-sync.

Full setup guide

01
Create a Biel.ai account
Sign up at app.biel.ai. 14-day free trial, no credit card. Create a new project for the docs you want indexed.
02
Connect your GitHub repo
Paste the repo URL in the dashboard. For private repos, add a personal access token with the repo scope. Biel reads the default branch and crawls files matching your include patterns.
03
Automate re-indexing on push
Drop a GitHub Actions workflow under .github/workflows/ that calls the sync API when docs change, scoped with paths: filters so unrelated commits don’t trigger crawls. Or run it manually from the dashboard.
04
Embed the assistant
Add the Biel widget to your GitHub Pages site, your docs site, or any web property. Readers ask questions in plain language and get documentation answers from the repo you just connected.

Before you install

Does it work with private repos?

Yes, with a GitHub token that can read the repository. Choose files suitable for the assistant’s readers because repository permissions are not inherited. Repository file links are not shown in answers.

Which file types are indexed?

Supported formats include Markdown, plain text, and reStructuredText. Use include / exclude patterns per source to select files and check indexing results.

How does it stay in sync with our repo?

Refresh from the dashboard, or trigger indexing from GitHub Actions on a plan with API access. Limit the workflow to documentation changes to avoid unnecessary indexing.

What if our docs are spread across multiple repos?

Add each repository as a source in one project. Connect published documentation URLs when readers need links to source pages, since repository file links are not shown in answers.

How long does the install take?

Connect a repo from the dashboard. Indexing time depends on repository size and access. The Actions workflow for auto-sync is one YAML file.

Make your GitHub docs answer questions

Try Biel with your docs Book a demo

14-day free trial · No credit card required

Use a different platform? See our integration pages for GitLab, Docusaurus, MkDocs, Sphinx, and Jekyll.