Discussions
How to add Multiple Section in Change log?
For ex: I have two products, say Product A and Product B.
In changelog, i don't say any option to create separate section for Product A and B. Is there a way to add multiple sections in change log?
Posted by Nagarjun over 1 year ago
How to add NodeJS code examples
Trying to add NodeJS code examples, and there are no option. So had to select JS as type. But in that way, I'm not being able to write any instruction on how to install the package. Same for Python, Java and other languages. There should be way to explicitly say, how the dev is going to include/install the package into their system.
Please let me know, if there is any way to do this, that I might have missed or any wayaround.
Thanks in advance, even if there is no way to do so, please do let me know any ideas on how to solve this issue with existing system.
Posted by Zahid Hasan Pranto over 1 year ago
how can i update my rails api documentation automatically
I want to know if readme.io offers any support to update API documentation automatically in the form of gems or any information regarding it will be welcome
Thanks
Posted by Abubakar over 1 year ago
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)
Posted by Brant Wellons about 1 year ago
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?
Posted by Kevin Mueller over 1 year ago
Platform Security
What level of security does readme.io have in place? Or, anything related to security of the platform?
Posted by Bryan about 2 years ago
Staging Environment for new versions of an OAS file
If we upload a new version of our OAS file, will the changes be reflected in the Staging Environment (and we can control when they are actually deployed)? (I'm currently evaluating Enterprise features and don't have access to a Staging Environment to test it out).
Posted by Tyler Freckmann almost 3 years ago
readme CLI without publishing
I am trying to run command line to update the existing api definition with a modified one.
rdme openapi [path to yaml] --key=rdme_xyz --id=abcd
Now I would like to find out 2 things
1. Can I push this new yaml in a dryrun/unpublished mode? so that I can verify it on readme devportal as an admin.
2. Or Can I upload this as a new api definition instead and make it in unpublished mode?
Posted by Naveen Velicheti over 1 year ago
Email Unsubscribe button not working
Hi Readme team,
The email unsubscribe button has not been working for me or my team. The link is in the format of:
x-webdoc://D7FC5252-99XX-9999-X9XX-3CA0CADC324B/unsubscribeUrl
Is there a way to remedy this?
Thanks in advance,
Branden
Posted by Branden Chan over 1 year ago
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.
Posted by Maya Mandel over 1 year ago