ReadMe

Guidelines to add and index your password-protected ReadMe Knowledge Sources

Prerequisite - Integrating with ReadMe

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 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, and your integration will be completed.

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.

• Hover over the "Add Knowledge Source" dropdown at the top right corner to select ReadMe.

Select ReadMe from the Knowledge Source dropdown

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)

1. 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

2. 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

1. Tags: Descriptive labels to organize and connect this knowledge source to AI agents. Default tags for ReadMe are pre-populated.

2. Auto Reindex Regularly: When enabled, the knowledge source will automatically reindex once every 24 hours. When disabled, you must manually reindex.

ReadMe Knowledge Source configuration drawer

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.

Using AI Agents

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

Build AI AgentsUse AI Agents

Manage Knowledge Sources

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

Manage