ReadMe
AI chat layered on your ReadMe developer hub
What is ReadMe?
ReadMe is a developer documentation platform that combines API reference (from OpenAPI specs), guides, changelogs, and recipes into a single branded developer hub. It is popular with API-first companies building developer portals.
How BeforeQuery works with ReadMe
Everything you can do once the integration is connected.
API reference + guide indexing
BeforeQuery crawls both your ReadMe guides and your rendered API reference pages, so developers 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 BeforeQuery crawler respects ReadMe's robots.txt configuration and only indexes content you have allowed.
Widget on every page
Add the BeforeQuery widget to your ReadMe custom JavaScript so the AI chat launcher appears across your entire developer hub.
How to set it up
Add your ReadMe docs URL to a BeforeQuery project. BeforeQuery will crawl all guides, API reference pages, and changelog entries.
Configure sync frequency to match your release cadence — weekly is common for active API docs.
Inject the widget script via ReadMe's 'Custom JavaScript' setting to display the AI chat launcher to all visitors.
Related integrations
BeforeQuery crawls your Mintlify docs site, keeps it in sync, and answers user questions with citations.
Crawl, sync, and embed AI chat on any Docusaurus v2 or v3 documentation site.
Index your GitBook spaces and let users ask questions with full citations back to source pages.
Ready to connect ReadMe?
Start free. No credit card required. Connect your first integration in under 5 minutes.