Discussions
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.
How do I get example responses to display?
I have examples included in the OpenApi.json but the example does not display in the readme.com. The example do display in both swaggerUI and redoc.
Let customers download open api spec
The admin dashboard has a way to export the api to oas spec file
Add WebM video to Product Guide
Hi there, is it possible to add WebM video to Product Guide?
How to edit the subnavigation bar?
It looks like I'm able to control the aspects of my projects on the landing pages. How do I control aspects on other pages? I am looking to edit the search functionality that appears in the top right of my docs pages.
Protected Documentation
Can I change the way the page looks for when we ask the user for a password for protected documentation?
Implementing Custom Search
I am looking to implement my own custom search. I know by default, ReadMe uses Algolia. I have indexed docs content in my own Algolia instance, and I want to make my own custom search experience. How would I go about customizing the search feature in ReadMe?
Post here or contact Support?
Wonder what other customers are doing?
Post here if you're looking for advice or best practices from fellow ReadMe customers!