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
For GitHub repos
Ask AI for your GitHub repo
Connect a GitHub repo once and Biel turns READMEs, docs folders, and code into source-cited answers for your customers and your team. Public or private. Auto-sync via GitHub Actions.
14-day freeSelf-serveLive in 15 min
acme / sdk-python
What Biel reads
- 📄 README.md
- 📁 docs/
- 📁 src/
- 📄 CHANGELOG.md
→
Used by teams that take their documentation seriously
What Biel reads from your repo
Four content types, one chatbot.
GitHub already hosts most of what your readers need. The job is to make it answerable in their words, with citations, on a surface that is not the GitHub repo browser.
docs/ folder
Markdown, MyST, reStructuredText. Whatever lives in your docs folder, indexed at the file level so citations link to the right anchor.
docs/**/*.md
Source code
Any file in the repo can be indexed: docstrings, code comments, JSON schemas, even raw source. Configure include / exclude patterns per repo.
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
From signup to live chatbot in 15 minutes
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 thereposcope. 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 withpaths:filters so unrelated commits don’t trigger crawls. Or run it manually from the dashboard. - 04
Embed the chatbot
Add the Biel widget to your GitHub Pages site, your docs site, or any web property. Readers ask questions in plain language and get source-cited answers from the repo you just connected.
Things teams ask during evaluation
Does it work with private repos?
Yes. Add a GitHub personal access token with the
repo scope to the source. The token is stored encrypted, used only to read the repo, and your customers do not need GitHub access to read the answers it produces.Which file types are indexed?
Any text-based file in the repo: Markdown, MyST, reStructuredText, source code (with docstrings and comments), JSON / YAML schemas, plain text. Use include / exclude patterns per source to scope what gets read.
How does it stay in sync with our repo?
Two options. Run a re-index from the dashboard whenever you want, or wire up a GitHub Actions workflow that calls the sync API on push. Most teams scope the workflow to
docs/** so unrelated commits do not trigger crawls.What if our docs are spread across multiple repos?
Add each as a separate source in one Biel.ai project. Answers can cite across repos, useful when an SDK, an API spec, and a tutorials repo all need to feed the same chatbot.
How long does the install take?
Connect a repo from the dashboard in two clicks. Under 15 minutes including the first crawl. The Actions workflow for auto-sync is one YAML file.
Where does our content go?
EU-hosted by default. GDPR compliant. File contents are read for indexing only and never used to train models.
Make your GitHub docs answer questions
14-day free trial · No credit card required · From $50/mo
Use a different platform? See our integration pages for GitLab, Docusaurus, MkDocs, Sphinx, and Jekyll.