Hybrid
Manage API definitions in Git while your team writes docs in ReadMe, for organizations scaling across products and teams.
Hybrid (Product & Docs)
Best for teams that:
Best for teams that:
- Have distributed ownership across teams
- Manage API specs in Git
- Want documentation to move quickly in ReadMe
- Are scaling across products or content surfaces
How it works
This setup combines the strengths of both workflows:
- CI/CD validates and publishes updates using rdme
- Content teams manage guides and API references in ReadMe
- Branches and versions support review and releases
Features to set up
- rdme Upload CLI
(rdme) - CI/CD (GitHub Actions, GitLab CI, etc.)
Learn More: Branches, Reviews & Notifications
Learn More: GitHub Actions: OpenAPI
Updated 6 days ago
Did this page help you?