Docs as Code (Git-focused)

Best for teams that:

• Practice Docs as Code
• Manage Markdown and OpenAPI definitions in Git
• Use pull requests as the primary review mechanism

How it works

All documentation and OpenAPI changes live in Git. Your existing CI/CD workflow stays the same:

• Make changes locally
• Open a pull request
• Review and merge
• CI/CD published updates to Readme using rdme
• ReadMe acts as the publishing and hosting layer while Git remains the source of truth

Features to set up

• ReadMe CLI (rdme)
• CI/CD (GitHub Actions, GitLab, CI, etc.)
• Learn More: GitHub Actions OpenAPI & GitHub Actions Markdown
• Learn More: The ReadMe CLI blog!