Discussions

I know that ReadMe is semver-ish with the supported versions, but this is posing a problem for us when we want to create a date-based version. We have a version 2022-09 that is not accepted by semver. Are there any suggestions for what we can do?

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?

Hello, Our backend is written in Golang, and we'd like to set up Personalized Webhooks, but there's not a README Golang SDK. Is it not possible to set up personalized docs without a ReadMe Golang SDK?

Hi there! Is there any way to customize the ordering of the parameters in a reference section from the OpenAPI template? It seems like however you format the template, the order is always path params -> body params -> headers. Is there any way to show the headers first?

I would like to set a default query parameter of type "Date time" to yesterday or 30 days ago instead of putting a static value. Is there a way we can achieve this? I couldn't find it in the help docs.

I need the list of topics (listed in the left panel) in one place for content structuring. I am able to export the entire data and .md files. But I only need the entire content list.

We're trying to track the percentage of users (if any) are viewing our ReadMe site on mobile and tablet devices. Does ReadMe track this or do I need to look to a Google Analytics integration?

It'd be nice to give my users a dropdown selector for ID instead of forcing them to copy paste from our service. I could pass a big list of values to README when the customer logs in, and that could populate the dropdowns.

Hi After successfully importing the swagger file , when I click on preview changes ,I get 404 not found in API reference section. Thanks Rishav

A user made a suggested edit to a guide document that included a change to the doc title. The content of the suggestion was good, but they used headline case, which is not our style. When I went into "suggest additional edits", I did not see a way to edit their suggested title change. My solution was to accept their suggested edit and then make my own edit to fix the case of the title. But I wondered if I missed something.