> For the complete documentation index, see [llms.txt](https://docs.clearfeed.ai/clearfeed-help-center/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.clearfeed.ai/clearfeed-help-center/clearfeed-ai/knowledge-sources/indexing-knowledge-sources/indexing-knowledge-sources.md).

# ReadMe

<details>

<summary>Prerequisite - <strong>Integrating with ReadMe</strong></summary>

To index your Knowledge Source, you must integrate your ReadMe account with ClearFeed. Begin this on the ClearFeed web app:

1. On the ClearFeed web app, navigate to `Settings` from the nav bar, and then open the [Integrations](https://web.clearfeed.app/settings/integrations) section.
2. Next, click on the `Connect` button next to ReadMe. This will open a modal.
3. Input your ReadMe sub-domain in the modal and click on `Connect`.
4. This will redirect you to ReadMe's sign-in page. Fill in your credentials and sign in.
5. After you sign in, you will be redirected to [ClearFeed](https://web.clearfeed.app/settings/integrations), and your integration will be completed.

</details>

### **Indexing a ReadMe Knowledge Source**

With the integration complete, you can now index your Knowledge Source:

**Step 1**: **Add your first Knowledge Source**

* From the left navigation bar on the ClearFeed WebApp, go to **AI >** [**Knowledge Sources**](https://web.clearfeed.app/knowledge-sources)**.**
* Hover over the "Add Knowledge Source" dropdown at the top right corner to select `ReadMe`.

<figure><img src="/files/eh4BHLORZtfzXBOA3GSP" alt="" width="563"><figcaption><p>Select ReadMe from the Knowledge Source dropdown</p></figcaption></figure>

A side drawer will appear, prompting you to provide specific details:

#### Required Configuration Fields

1. **Name**: Designate a title for this Knowledge Source, which will be displayed on ClearFeed.
2. **Base URL**: The base URL for your ReadMe documentation site (e.g., `https://docs.example.com`). This field auto-populates from your integration metadata.
3. **Index Entities**: Select which ReadMe content types to index (at least one required):
   * **Guides** - Documentation guides and articles
   * **APIs** - API documentation
   * **Changelogs** - Release notes and changelogs

#### Conditional Fields (when "Guides" is selected)

4. **Guide Categories Scope**: Choose how to index guide categories:
   * **Index all guide categories** - Include all categories from your ReadMe instance
   * **Index specific guide categories** - Choose particular categories to index
5. **Specific Guide Categories**: (Only shown when "Index specific guide categories" is selected)
   * Select from available categories fetched from your connected ReadMe instance
   * At least one category must be selected

#### Optional Fields

6. **Tags**: Descriptive labels to organize and connect this knowledge source to AI agents. Default tags for ReadMe are pre-populated.
7. **Auto Reindex Regularly**: When enabled, the knowledge source will automatically reindex once every 24 hours. When disabled, you must manually reindex.

<figure><img src="/files/tL6I8qUl6FCQutwUPEOJ" alt="" width="563"><figcaption><p>ReadMe Knowledge Source configuration drawer</p></figcaption></figure>

**Step 2**: **Save and Index**

After saving your configuration, the Knowledge Source will either start indexing immediately (reflected by an **In Progress** status) or will be picked up soon (reflected with an **Initiated** status).

**Reindexing ReadMe Docs**: To manually reindex ReadMe documents, click the "Reindex" button next to the knowledge source.

Get more details on Managing Knowledge Sources [here](/clearfeed-help-center/clearfeed-ai/knowledge-sources/managing-knowledge-sources.md).

### Using AI Agents

Once you've configured the knowledge sources, learn how to build and use AI Agents

{% content-ref url="/pages/BG6lBe8zAALu5HQvWnQQ" %}
[Build AI Agents](/clearfeed-help-center/clearfeed-ai/ai-agents/build-ai-agents.md)
{% endcontent-ref %}

{% content-ref url="/pages/KfSu1GlJW2NmCvxVTv5c" %}
[Use AI Agents](/clearfeed-help-center/clearfeed-ai/ai-agents/use-ai-agents.md)
{% endcontent-ref %}

### **Manage Knowledge Sources**

Once the status of the knowledge source has been indexed, learn more on how to manage the knowledge source below.

{% content-ref url="/pages/4mEyGIe8R45x3rjcY7ug" %}
[Manage](/clearfeed-help-center/clearfeed-ai/knowledge-sources/managing-knowledge-sources.md)
{% endcontent-ref %}