ReadMe

What it does

ReadMe is a comprehensive documentation platform that helps teams create beautiful, interactive API documentation with built-in tools for collaboration, AI assistance, and developer monitoring.

Straight answers

What is OpenAPI documentation support in ReadMe?

ReadMe allows you to upload your Open API specification and automatically generates a dynamic API Reference with code samples and authentication handling. You can also import via URL, connect directly to GitHub or GitLab repositories, and automate syncing with CLI or API Sync.

Can you create API documentation without an OpenAPI specification?

Yes, ReadMe provides a visual API Designer that allows you to build your API reference from scratch without requiring an OpenAPI specification. You can document endpoints by pointing, clicking, and publishing without writing any code or YAML/JSON.

How does ReadMe integrate with GitHub and GitLab?

ReadMe bi-directionally syncs with GitHub, GitHub Enterprise Server, and GitLab. You can review, approve, and merge Git branches directly in ReadMe, and changes land on a review branch before going live to documentation. This allows you to use pull requests for documentation changes just like code.

What AI features does ReadMe offer?

ReadMe offers multiple AI features including AI Writer that proposes documentation updates when code changes, AI Linter that enforces writing style guides automatically, Agent for editing and reviewing docs with an AI writing assistant, and Ask AI for searching documentation. These tools help analyze pull requests, detect broken links, and automatically update affected documentation pages.

What security and compliance features does ReadMe Enterprise offer?

ReadMe Enterprise includes SOC2 and GDPR compliance certifications, role-based access controls with granular permissions, SSO integration with identity providers like Microsoft Entra ID, Okta, and Google Workspace, detailed audit logs to track every change, and dedicated support. Migration services and implementation services are also provided.