README

Import developer documentation from README.io into AGO

Import developer documentation from README.io into AGO. Sync your API reference, guides, and changelogs for AI-powered developer support.

Overview

Feature	Details
Authentication	API Key
Content Type	API docs, guides, changelogs
Hierarchy	Categories and pages
Filter Support	By category, content type

Prerequisites

• README.io account
• API key with read access

Getting Your API Key

1. Log in to README.io
2. Navigate to Project Settings > API Keys
3. Copy your API key

Configuration

Required Fields

Field	Description	Example
api_key	README API key	rdme_xxxxx

Optional Fields

Field	Type	Description	Default
external_link_base	string	Base URL for external links	Auto-detected
import_categories	boolean	Import category pages	true
import_guides	boolean	Import guide pages	true
import_api_reference	boolean	Import API reference	true
import_changelogs	boolean	Import changelog entries	true
category_filter	array	Category slugs to import	All

Setup Steps

1. Navigate to Knowledge → Sources
2. Click Create Source
3. Select README as the source type
4. Enter your API key
5. Configure import options:
   • Select content types to import
   • Add category filters if needed
6. Click Save
7. Click Sync to start importing

Content Types

Guides

Tutorial and conceptual documentation:

• Getting started guides
• How-to articles
• Conceptual explanations

API Reference

Automatically generated API documentation:

• Endpoint descriptions
• Request/response examples
• Authentication details

Changelogs

Version history and release notes:

• Feature announcements
• Breaking changes
• Bug fixes

Filtering by Category

Import specific categories only:

{
  "import_guides": true,
  "import_api_reference": false,
  "category_filter": ["getting-started", "authentication"]
}

External Links

Configure external_link_base to enable links back to your README docs:

{
  "external_link_base": "https://docs.yourapi.com"
}

Content Structure

README documentation structure:

Troubleshooting

Authentication Error

• Verify your API key is correct
• Check the key hasn’t been revoked
• Ensure the project is accessible

No Content Imported

• Check you have published documentation
• Verify import flags are enabled for desired content types
• Review category filters aren’t too restrictive

API Reference Missing

• Ensure import_api_reference is enabled
• Check if API reference is published in README.io

Related Documentation

• Knowledge Connectors - All available connectors
• Knowledge Source Management - Source configuration