These docs are for v2.0. Click to read the latest docs for v3.0.

Discussions

Ask a Question
ANSWERED

How to define a enum string

How to define a enum string

ANSWERED

How long will the old ReadMe experience (not ReadMe Refactored) be maintained?

rdme@10 has been prepared, and we can make the transition at any time. However, some people think that it is not necessary to make the transition until it is necessary.
Is there a deadline or roadmap planned for the complete transition from the old ReadMe experience to ReadMe Refactored?

ANSWERED

Gating content at the page level

Is it possible to password protect content on our docs site at the page level and not at the whole project level? FYI we are on the Enterprise version of ReadMe.

Code block syntax highlighting

Hi Team,

Version naming schemes other than semver

Is there a way to get versions without semantic versioning? We want to have a version "latest" for cicd builds, and then #.#.# for specific released versions.

Bug | Changelog RSS feed with future date

Changelog items which are marked as public, but have for a datetime in the future, are already available in the changelog RSS. Via this, the direct changelog url is already exposed to RSS-readers (and followers), which is in my opinion a non desired behavior. Items should only be added to the RSS-feed once made public, and datetime has passed.

ANSWERED

Getting error in validate command

While executing rdme openapi:validate command we are getting error SyntaxError: Unexpected token 'with' Exit Code : 1 in workflow output.

ANSWERED

While integrating update document API getting this error - https://dash.readme.com/api/v1/api-specification/{id}

In java code encoding and decoding working fine but when passing encoded string in request getting this error

ANSWERED

Versioning

Hi,

ANSWERED

How to implement SP provided SSO with readMe

We have an application of developer hub which is readMe based and we need to implement service provider SAML SSO in it. So we need some details for SSO URL, Entity ID, IdP SSO URL, IdP Issuer, X.509 Certificate for implementing it.