G
Code & Repositories

GitHub

Index GitHub docs and keep them synced on every push

What is GitHub?

GitHub is the world's largest code hosting platform. Engineering teams store not just code but also architecture decision records, runbooks, API references, and internal documentation in GitHub repositories.

Integration

How BeforeQuery works with GitHub

Everything you can do once the integration is connected.

Selective path indexing

Choose exactly which paths to index: docs/, README.md, ADRs/, runbooks/, or any markdown files. BeforeQuery only indexes what you specify.

Webhook auto-sync on push

BeforeQuery installs a webhook verified with X-Hub-Signature-256. Every push to your configured branch triggers an incremental re-index — docs stay current without manual intervention.

Self-hosted GitHub Enterprise

The GitHub integration supports GitHub Enterprise Server installations in addition to GitHub.com.

Branch-aware indexing

Configure which branch is indexed — main for stable docs, or a separate docs branch. Switch branches without re-configuring the integration.

Setup

How to set it up

1

In BeforeQuery, create a source of type GitHub and authenticate with your GitHub account or organization.

2

Select the repository and configure which paths and branch to index. BeforeQuery will install the push webhook automatically.

3

Run the first sync. Subsequent syncs trigger automatically on every push to the configured branch.

Ready to connect GitHub?

Start free. No credit card required. Connect your first integration in under 5 minutes.