Discussions

Ask a Question
Back to All

How to merge "manual" edits with OpenAPI docs generated from source code?

My team currently updates API docs manually via the readme UI, but we're exploring auto-generating the docs from the code of our rails app, and updating them via the readme API. We're stuck on what the correct pattern would be to resolve potential conflicts between manual edits directly in readme, and whatever new edits are generated from code and synced up via OpenAPI.

Does Readme have functionality to handle that? Has anyone found a pattern that works well for it?