Setting up ReadMe as a Source

👥

Access Required

Guru 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

1. In Guru, go to Manage > Sources.
2. Select ReadMe from the list of available sources.
3. 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
4. Enter your API token in the ReadMe connection field in Guru.
5. Choose which Guru Groups should have access to this content.
6. Click Connect Source.

Objects synced from ReadMe

The ReadMe source integration syncs specific content from your ReadMe documentation:

✍️

Note

• 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

💡

Tip

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

Permissions

• When you connect ReadMe as a source in Guru, you'll permission that content in Guru. Learn more here.
• If someone is not provided with access in Guru to this source, they will not see ReadMe results in searches or when chatting with Guru.