Discussions

Ask a Question

Support for date-based API versions

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?
ANSWERED

HELP! How to restore a deleted page

Hi, I just delete several pages and saved unexpectedly, how could I restore them? thank you so much
ANSWERED

Does ReadMe track device usage?

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?
ANSWERED

404 Page Not Found in API Reference section

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

Is there a way to embed your OpenAPI calls in the Guides

When you are writing the descriptive guides, it would be nice to be able to embed an interactive API call in the guide that can be tracked.
ANSWERED

Dynamic default date query parameter?

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.
ANSWERED

How to export an exhaustive list of topics in the "hub-sidebar" of a particular page in readme?

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.
ANSWERED

Can "suggest additional edits" to the document title?

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.
ANSWERED

How to set up personalized webhooks for Golang server?

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?

Is it possible to pass a list of objects to choose from to a field in readme?

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.