Discussions

Ask a Question
ANSWERED

Manage Content as Code (CaC) - Readme Terraform Provider

Our team is heavily reliant on Terraform for Infrastructure as Code. We wanted to be able to manage our Readme documentation in a similar Content-as-Code fashion within our pipelines but there wasn't an easy way to do that. We spent some dev cycles on building a proper TF provider for Readme that enables managing guides, API references, categories, images and so on. We have recently published it to the public domain and welcome feature contributions from the greater Readme community. [Readme Terraform Provider](https://registry.terraform.io/providers/LiveOakLabs/readme/latest/docs)

Chrome left side navigation missing

Recently, when using Chrome, the left had side navigation is missing all the information that was there. the left side slide out but is blank. Any hints on to debug this or get the links back?
ANSWERED

Do you support fullstory integration?

ANSWERED

All supported markdown headers?

Is there a list of all supported readme-flavored markdown headers on one of your help pages? I know of title, slug, excerpt, category, order, and hidden. Thank you!

Manually added "What's next" pages do not get title updates.

Typically, if when editing a document through the dashboard, I do not modify the "What's next" field at the very bottom, then when viewing the article, I will have two links: one to the previous page, and one to the next page. These links are described with the current titles of the pages they link to. That's great. However, if I manually add a page, e.g. I am editing page A, which has subpage A.1, but I want to link to page B in the same category, then I encounter difficulties when I change the title of page B. Then, if I change page B to be titled C, the "What's next" section in page A contains a link called "B" pointing to page C. Could the titles of these links be kept up to date with the titles of the pages?

SEO issues when using ReadMe: Controlling metadata for every single URL + /docs directing to the first doc

We keep getting hammered in SEO audits (and thus panelized by Google) on the fact that I as the content writer cannot control the meta-description for the "sections" in ReadMe (not single docs - sections like /discussions, /docs, etc.). So then either they all have the same metadata description (from the project-level setting), or have to be empty. Another built-in issue is that /docs will always show the content of the first doc, so those are two different URLs with the same content. ReadMe is used by most teams I assume to publish documentation online, so that it's easily accessible and searchable. I've reported this to your support team about 4 months ago in September and was told that this is just not supported, but I find it hard to accept that something so trivial and basic cannot be achieved with this product that I love using. Can you please advise how to solve this? 1. Editing meta description separately for /docs, /discussions /changelog, etc. 2. Making sure /docs does not show the same content as the first guide Thanks.
ANSWERED

Page with large table doesn't load

I have an appendix in my guide, which is one very long table. It is definitely published and it appears in the TOC on the side. But when I try to open it from another page in my project, the icon on the browser tab spins as if it's thinking, but then even though the URL changes to the correct URL, I still see the same page I was on before. If I try to open the page directly from the URL (not from another page in my project), I get a 500 Internal Server Error. Why is this happening and how can I fix it? Thanks.

API Conventions for /api-specification

**GET /api-specification** returns a collection instead of single api and there is no **GET /api-specification/{id}** call. I would expect an **/api-specifications** endpoint to exist and return a collection Would ReadMe be open to adopting the following? **GET /api-specifications** **POST /api-specification** **GET /api-specification/{id}** **DELETE/api-specification/{id}** **PUT /api-specification/{id}** Ref Google's api design guide <https://cloud.google.com/apis/design/>
ANSWERED

Changlog Content is not rendering.

<https://docs.os1.delhivery.com/changelog> for some reason the content has stopped rendering. Any idea why?
ANSWERED

Is there a way to filter endpoints by User role?

We have a OAS file with multiple endpoints , I was wondering if there is a way to display some of these endpoints by user role. Thanks in advance.