> ## Documentation Index
> Fetch the complete documentation index at: https://doc.indexbrain.online/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub

> Connect GitHub to read issues, pull requests, workflows, and documentation.

Connect Indexbrain to GitHub to read issues, pull requests, GitHub Actions workflows, and documentation — read-only.

## Setup

<Steps>
  <Step title="Go to Integrations">
    Navigate to **Settings > Integrations > GitHub**.
  </Step>

  <Step title="Authorize">
    Click **Connect** and authorize Indexbrain in GitHub.
  </Step>
</Steps>

<Note>
  This is a standard GitHub OAuth connection, not a GitHub App installation
  — there's no per-repo picker. Indexbrain has access to whatever
  repositories the connecting GitHub account can see.
</Note>

## What gets synced

* **Issues** — all states, real content and labels.
* **Pull requests** — all states, including whether merged.
* **GitHub Actions workflow files** (`.github/workflows/*.yml`/`.yaml`) — a written, step-by-step process, high-value source material for understanding how your team deploys and ships.
* **README** — each repo's root README.
* **Documentation** — markdown files under a top-level `docs/` folder, if one exists.

Updates are picked up correctly — if an issue is reopened, a PR is merged, or a README is edited, that change is reflected on the next sync rather than the item staying frozen at its first-synced state.

### Examples

```
Can you explain how our deploy process works?
What issues are open in the billing repo?
Summarize what changed in the last few PRs to the API service.
```

Answers to "explain how X works" questions are only as good as what's documented — Indexbrain reads README files, `docs/` folders, and workflow files, not your raw source code. If something isn't written down anywhere, Indexbrain can't explain it from GitHub alone.

## What Indexbrain does not do in GitHub (yet)

* **No general source code indexing** — only README, `docs/*.md`, and workflow YAML files are read. Individual `.py`/`.ts`/etc. source files are not indexed.
* **No commits.**
* **No write access of any kind** — Indexbrain cannot open a pull request, comment on an issue or PR, or push any change. Every GitHub interaction is a read.
* **No automated PR review** — there's no bot that reviews pull requests, posts comments, or gates merges. Nothing runs automatically when a PR is opened.
* **No repo picker** — access is all-or-nothing based on what the connected GitHub account can see, not a per-repo selection inside Indexbrain.

## How data moves

GitHub syncs on your configured processing interval (no live push/webhook feeds ingestion today — an edit in GitHub is picked up on the next scheduled sync, not instantly). Once synced, content becomes searchable within roughly another minute.

## Troubleshooting

<AccordionGroup>
  <Accordion title="A repo I have access to isn't showing up">
    * Confirm the GitHub account used to connect actually has access to that repo.
    * Large accounts/orgs are capped at 300 repos per sync.
  </Accordion>

  <Accordion title="An issue/PR I edited doesn't reflect the change">
    * Wait for the next scheduled sync, or trigger a manual sync — GitHub has no live push today.
  </Accordion>

  <Accordion title="Indexbrain can't answer a question about how something works in the code">
    * Check whether it's actually documented in a README or `docs/` file — Indexbrain doesn't read raw source code, only documentation and workflow files.
  </Accordion>
</AccordionGroup>