Docs-as-code
Run documentation entirely through Git, with Markdown and OpenAPI in your repository and pull requests as the review step.
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 publishes updates to ReadMe using rdme
- ReadMe acts as the publishing and hosting layer while Git remains the source of truth
Using Bi-Directional Sync? You don't need
rdme. Merging to your synced branch publishes your changes, and the ReadMe CLI (@readme/cli) handles linting and OpenAPI validation in CI.
Features to set up
- rdme Upload CLI
(rdme) - CI/CD (GitHub Actions, GitLab CI, etc.)
- Learn More: GitHub Actions OpenAPI & GitHub Actions Markdown
- Learn More: The ReadMe CLI blog!
Updated 6 days ago
Did this page help you?