# GitHub

Designed to retrieve data from GitHub, this loader parses Markdown (.md) and text (.txt) files only. It can also auto-refresh and track any changes to these files, notifying the user of missing or new content. Advanced features will include code identification and hyperlink parsing.

{% hint style="info" %}
If you need to load documentation in any other format (such as .mdx), use the Website agent to load the documentation from the published website.
{% endhint %}

### Configuration

The GitHub agent can be configured to track specific information about a linked repository.

{% hint style="info" %}
You can only have one agent per branch in a repository. However, you are free to set up agents on different branches in the same repository.
{% endhint %}

| Configuration option | Explanation                                                                                                                                                                                                                                                                 |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Repository url       | URL of GitHub repository to get data from                                                                                                                                                                                                                                   |
| Repository branch    | Branch of GitHub repository to get data from                                                                                                                                                                                                                                |
| File types           | Types of files to pull when searching through this repository. These can only be markdown (.md) and/or text (.txt) files. If you need to load documentation in any other format (such as .mdx), use the Website agent to load the documentation from the published website. |
| Schedule             | When to automatically run this agent                                                                                                                                                                                                                                        |
| Include PRs          | If enabled, the agent will also include pull requests in the data it tracks. We track the PR's related issue, changes to any files, requested reviewers, and when it was merged if it already has been merged.                                                              |
| Include Issues       | If enabled, the agent will also include issues in the data it tracks. We track the content of the issues as well as relevant metadata.                                                                                                                                      |
| Tags                 | Tags are applied to all future data collected by this agent, which can be used later for filtering.                                                                                                                                                                         |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.katara.ai/about/agents/loaders/github.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.