Discussions

Ask a Question
ANSWERED

Is there a way to upload or manage an XML Sitemap with ReadMe?

I would like to create and manage an XML Sitemap of our Docs website with, which uses ReadMe. Is there an option to manage an XML Sitemap or upload an XML file to a subfolder?

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

Displaying recursive data results from an API

My api response returns data with the following structure ```json json { "data": [ { "id": "", "name": "", "children": [ { "id": "", "name": "", "children": [ ] }, { "id": "", "name": "", "children": [ ] }, ] } ] } ``` The children contains other children and so on, what is the best way to do so?
ANSWERED

Error submitting form after updating a page

When I update a Guide page, I get a message that says error submitting form. This happens after entering text and clicking the Save to Staging button. The page that I am working on is quite large with many tables. Do you have any ideas why I am getting this error and what I can do?
ANSWERED
ANSWERED

Moving conent around

Is it possible to make an existing page a subpage of another existing page?
ANSWERED

How to recreate the reference getting started page?

I really like the Getting Started page here when you go to the API Reference: <https://docs.readme.com/reference/introduction> 1. How can I recreate those Pick a language, Authenticate, Try it sections? 2. How to recreate the blue "Get API Key" button in the authentication form? 3. When you view an endpoint, how to recreate that "Log in to use your API keys" text/link?
ANSWERED

Editor woes

It appears that legacy editor no longer saves content correctly (or sometimes at all) Then new editor freezes when trying to change the type of a code block. Did you bother testing any of this?
ANSWERED

Is it possible to make categories expandable?

Our left-hand navigation is getting quite long. Is it possible to make a category retractable and expandable so that users only see the category name until they choose to expand it?
ANSWERED

Can I recover a documentation page within API Reference?

I see how to use Page History within Guides to recover content, but have found no way to recover a deleted documentation page with the API Reference section.