Discussions

We've recently started to use readme.io, and we've run into a problem. It seems that readme.io is unable to render endpoints that include a parameters section that $ref a file that has already been $ref before.

Are you planning to add support for other types of API? like SDK documentation?

build

There appears to be a bug in the way ReadMe is rendering descriptions of complex schemas that make use of allOf to combine multiple schema and reference objects.

Currently we have a token header that will contain a space
When this is added, the example request fills in that header space with an encoded %20 which breaks the sample request. This is the case with all of our docs, where none of the sample requests will work

We recently launched our website and discovered that none of our published articles are searchable by Google. This is because there is no sitemap available for readme pages, so Google won't index them. Our temporary solution is to manually create and update a sitemap.xml every time a new article is added, but this is very cumbersome.

Currently it is not possible to set theme to Same as System on iPhones when using Safari browser.

We have extensive product documentation on Readme and would love to learn how we can potentially use Chat GPT to generate answers for our customers and customer support agents.