Setting up ReadMe as a Source
Connecting ReadMe makes it easy to turn your existing documentation into a searchable knowledge source for AI-powered answers. Learn how to connect your ReadMe documentation, manage permissions, and use your guides to generate trusted responses.
Access RequiredGuru Access: You need to be an Admin, Source Creator, or relevant custom role to set up Sources
ReadMe Access: You need access to your ReadMe dashboard to generate an API token
Setting up the integration
- In Guru, go to Manage > Sources.
- Select ReadMe from the list of available sources.
- Get your ReadMe API token:
- Go to your ReadMe dashboard
- Navigate to the API key section:
https://dash.readme.com/project/[your-project]/v1.0/api-key - Copy your API token
- Enter your API token in the ReadMe connection field in Guru.
- Configure sync settings:
- The integration will sync automatically every 2 hours
- Choose which Guru Groups should have access to this content
- Click Connect Source.
What gets synced
The ReadMe source integration syncs specific content from your ReadMe documentation:
| Content Type | What's Included | Format | Frequency |
|---|---|---|---|
| Guides documentation | All guide pages and articles | HTML content with full formatting | Every 2 hours |
| Page metadata | Titles, URLs, and unique identifiers | Structured data | Every 2 hours |
| Content structure | Document hierarchy and organization | Maintains ReadMe structure | Every 2 hours |
What's not synced
- API Reference documentation - These are not included in the automatic sync
- Comments or community discussions - Only the core documentation content is synced
- Draft or unpublished content - Only published guides are available
TipIf you need to include API Reference documentation as a source, you can upload your Swagger or OpenAPI specification files using Guru's File Upload source as a workaround.
Updated about 3 hours ago