ReadMe Docs Integration
Connect your ReadMe.com documentation site to enable agents to search and read your docs during investigations. Supports both public and password-protected documentation sites.
Capabilities
Once connected, agents can:
| Capability | Description |
|---|---|
| Search Docs | Full-text search across your documentation site |
| Read Pages | Retrieve and analyze specific documentation pages |
| Browse Categories | Navigate documentation structure and categories |
| Knowledge Retrieval | Use your docs as context during investigations |
Prerequisites
- A ReadMe.com documentation site
- The site URL and ReadMe subdomain
- The site password (if the docs are password-protected)
Setup
1
Get Your Site Details
- Navigate to your ReadMe documentation site
- Note your site URL (e.g.,
https://docs.mycompany.com) - Note your ReadMe subdomain (usually matches your company name, e.g.,
mycompany)
2
Add Integration in Autoheal
- Go to Integrations in Autoheal
- Click ReadMe Docs
- Enter a name (e.g., "Product Documentation")
3
Configure Credentials
Enter the following:
- Docs Site URL: Full URL of your ReadMe documentation site (e.g.,
https://docs.mycompany.com) - ReadMe Subdomain: Your company/project name in ReadMe (e.g.,
mycompany) - Site Password (optional): Password for password-protected docs
4
Test and Save
Click Test Connection to check the connection, then click Save.
Configuration Fields
| Field | Required | Description |
|---|---|---|
| Docs Site URL | Yes | Full URL of your ReadMe documentation site |
| ReadMe Subdomain | Yes | Your company/project name used in ReadMe |
| Site Password | No | Password for password-protected docs (leave empty for public sites) |
tip
Your ReadMe subdomain usually matches your docs URL. For example, if your docs are at docs.mycompany.com, the subdomain is likely mycompany.
Example Queries
Once connected, you can ask an agent questions like:
Search our docs for information about rate limiting
What does our documentation say about the authentication flow?
Find the troubleshooting guide for webhook errors
Look up the API reference for the /users endpoint in our docs
Troubleshooting
Documentation Not Found
- Check that the site URL is correct and accessible
- Check that the ReadMe subdomain matches your site
- Check that the documentation site is published and not in draft mode
Access Denied on Protected Docs
- Check that the site password is correct
- Check that the password has not been changed recently
- Re-enter the password in the integration settings
Search Returns No Results
- Check that the documentation site has published content
- Try broader search terms
- Check that the pages are not marked as hidden in ReadMe