Skip to content
AskVault Docs
Try Free →

GitHub integration use cases

Written by , Founder, AskVault · Reviewed by Aashiq
Last updated: · 4 min read

1. Engineering helpdesk in Slack

Most common pattern. Index your runbooks, READMEs, and design docs from GitHub:

  • Engineer asks "How do we deploy a hotfix?" in #engineering.
  • Bot pulls the relevant runbook from /docs/runbooks/.
  • Reply within 2 seconds with cited content.

About 30 to 50% of engineering helpdesk questions answer this way.

2. Support context from closed issues

When a customer reports a bug:

  • Support agent asks bot "Has this bug been reported?"
  • Bot searches closed issues for matching reports plus resolutions.
  • Surface relevant issues with "fixed in v2.5" annotations.

Cuts agent investigation time by 50 to 70%.

For on-call engineers:

  • "What's the rollback procedure for migration X?"
  • Bot pulls /docs/runbooks/database-migrations.md with the procedure.
  • Cites with line numbers for easy verification.

Saves about 5 to 15 minutes per incident on context-gathering.

4. PR description retrieval

Enable PR-description indexing:

  • "What did Alice change in PR #1234?"
  • Bot pulls the PR description plus title.
  • Useful for code-review context plus changelog generation.

5. Architectural decision lookups

For ADR-heavy teams:

  • "Why did we pick PostgreSQL over MySQL?"
  • Bot pulls /docs/adr/0001-database.md with the full ADR.
  • Cites the ADR file plus date.

Setup

30 minutes:

  1. Connect GitHub via OAuth. See GitHub integration setup.
  2. Pick repos to index.
  3. Configure include paths (/docs/**, *.md in root).
  4. Optionally enable code-aware indexing.
  5. Trigger initial sync.

Code-aware vs docs-only

Two modes:

Docs-only. Index README, /docs, markdown files. Standard.

Code-aware. Index source files too. Bot answers "where is function X defined?" Increases storage by 2 to 3x.

Pick based on use case. Most teams start docs-only.

Audience tags

By default internal for code repos (private). Useful for:

  • Engineering-only docs. internal-engineering.
  • Customer-facing docs if your repo is public. public.

Plan considerations

  • Free, Starter. No GitHub.
  • Growth. Up to 5 repos, docs-only. Standard helpdesk pattern.
  • Business. Up to 50 repos, code-aware, issues plus discussions.
  • Enterprise. Unlimited.

Limits

  • Repos per workspace. 5 to 50 by plan.
  • Files per repo. 5,000.
  • Sync. Webhook-triggered within 30 seconds.

Common pitfalls

Code chunks return without context. Add neighboring-chunk setting.

Issue noise. Filter by label (only customer-facing issues).

Webhook not firing. Re-create webhook in GitHub repo settings.

FAQ

Does this work with GitHub Enterprise Server (on-prem)?

Yes via API token. Public Enterprise: OAuth. On-prem: contact support.

Will the bot leak proprietary code?

Audience tags prevent. Tag code repos internal; require identity verification.

Can I index across organizations?

Yes if OAuth user has access.

Was this page helpful?