What is ReadMe?
ReadMe is a documentation platform that combines API reference (from OpenAPI specs), guides, changelogs, and recipes into a single branded knowledge hub. It is popular with API-first companies building product portals.
How Kelu works with ReadMe
Everything you can do once the integration is connected.
API reference + guide indexing
Kelu crawls both your ReadMe guides and your rendered API reference pages, so users can ask questions about endpoints, parameters, and concepts in one conversation.
Changelog awareness
Index your ReadMe changelog so users can ask what changed in the latest release, with answers that cite the exact changelog entry.
Robots.txt-compliant crawler
The Kelu crawler respects ReadMe's robots.txt configuration and only indexes content you have allowed.
Widget on every page
Paste the Kelu widget snippet into ReadMe's Custom Code (Footer HTML) so the AI chat launcher appears across your entire knowledge hub.
How to set it up
- 1
Add your ReadMe docs URL to a Kelu knowledge base. Kelu will crawl all guides, API reference pages, and changelog entries.
- 2
Kelu re-crawls your hub every 24 hours. Click Sync Now right after a release to update at once.
- 3
Paste the widget snippet into Footer HTML under ReadMe's Customization > Custom Code to display the AI chat launcher to all visitors.
Related integrations
Mintlify
Kelu crawls your Mintlify docs site, keeps it in sync, and answers user questions with citations.
View details
Docusaurus
Crawl, sync, and embed AI chat on any Docusaurus v2 or v3 documentation site.
View details
GitBook
Index your GitBook spaces and let users ask questions with full citations back to source pages.
View detailsGot questions?
ReadMe — Frequently Asked Questions
Common questions about connecting Kelu to ReadMe.
Yes. Kelu crawls your entire ReadMe knowledge hub — guides, rendered API reference pages generated from your OpenAPI spec, changelogs, and recipe pages — so users can ask questions about any part of your documentation in a single conversation.
Yes. Because Kelu indexes your ReadMe API reference pages, users can ask questions like 'What parameters does the POST /users endpoint accept?' and receive AI answers with citations back to the exact reference page.
Paste the Kelu widget snippet into Footer HTML under ReadMe's Customization > Custom Code. The launcher will then appear on every page of your knowledge hub without requiring changes to the ReadMe project structure. Custom code needs a ReadMe plan that includes it.
Kelu re-crawls your hub every 24 hours. You can also trigger a manual sync (Sync Now) from the Kelu dashboard immediately after a major release to ensure users always get the latest information.
Yes. Changelog pages are crawled and indexed alongside guides and API references. This means users can ask 'What changed in version 2.1?' and receive a cited answer referencing the exact changelog entry.