Documentation Platforms

ReadMe AI Integration

AI chat layered on your ReadMe knowledge hub

What is it?

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

Integration capabilities

How BeforeQuery works with ReadMe

Everything you can do once the ReadMe integration is connected.

API reference + guide indexing

BeforeQuery 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 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 knowledge hub.

Setup

How to connect ReadMe

Step 01
Add your ReadMe docs URL to a BeforeQuery knowledge base. BeforeQuery will crawl all guides, API reference pages, and changelog entries.
Step 02
Configure sync frequency to match your release cadence — weekly is common for active API docs.
Step 03
Inject the widget script via ReadMe's 'Custom JavaScript' setting to display the AI chat launcher to all visitors.

Explore

Related integrations

Mintlify

BeforeQuery crawls your Mintlify docs site, keeps it in sync, and answers user questions with the source shown.

Docusaurus

Crawl, sync, and embed AI chat on any Docusaurus v2 or v3 documentation site.

GitBook

Index your GitBook spaces and let users ask questions with full links back to source pages.

ReadMe — Frequently Asked Questions

Common questions about connecting BeforeQuery to ReadMe.

Yes. BeforeQuery 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 BeforeQuery indexes your ReadMe API reference pages, users can ask questions like 'What parameters does the POST /users endpoint accept?' and receive AI answers with the source shown back to the exact reference page.

Use ReadMe's 'Custom JavaScript' setting to inject the BeforeQuery widget script tag. The launcher will then appear on every page of your knowledge hub without requiring changes to the ReadMe project structure.

For actively maintained content, a weekly sync aligns well with most release cadences. You can also trigger a manual sync from the BeforeQuery 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 grounded answer referencing the exact changelog entry.

Ready to connect ReadMe?

Start free. No credit card required. Connect your first integration in under 5 minutes.

Get started free