Hi, There's a 3rd party provider, Pendo, which we'd like to integrate with our doc site. This will help us with analytics and surveys. What is the process for getting pendo.io integrated with our 2 doc sites hosted by readme?
Posted by Amy Prochnau 2 years ago
Hi guys, As we are using readme.io for a while now, I have a couple of questions regarding readme.io's versioning and URL structure which seem to be a bit confusing for us (and for Google). We only use one version which also is the main version. When looking at the indexed pages on google, I can see that both URLs "v1.0" and those without "v1.0") are indexed by Google. As some pages are indexed twice (with and without the "v.10") I think this could possibly harm our search visibility + ranking (due to duplicate content). How do you guys handle that topic? Best, Tom PS: Are there any plans to offer a sitemap?
Posted by Thomas 2 years ago
Dear Readme.io, this is a long term issue that bothers a lot. Subsection links are generated automatically without any means how to rewrite them (just like page slugs for regular pages). How can we change the links? Do you plan to add this feature? Shall we send you the places and new values so that you can override them directly in database? Kind regards, Nobo
Posted by Nobo Nadie 2 years ago
Hey guys, We need to display help content from the readme.io pages in our product. What is the best way to go about doing this? Is there an API that readme provides? A couple of options come to mind: scraping the page for one but it seems that the pages are AngularJS enabled and that won't work. Thanks for the help!
Posted by ScaleGrid Developers 2 years ago
In the API reference editing section, I can reorder a "page" to be the first item in the menu. After doing this the first time it works, however if I save the page again it gets reordered to after the API endpoints. This appears to be a bug.
Posted by Steve Heffernan 2 years ago
Hi, On smaller screens the table component creates an automatic scroll bar horizontally, causing the user to scroll the bar to access the data. how to get around this? has it customizing for it not to occur, maybe a theme or css? use case https://cl.ly/0z2g0c2s1g2u
Posted by Altevir 2 years ago
Hello, We have a couple projects that were created/started using the "duplicate project" feature. This seems to work as expected, with one exception. All our ref docs in the duplicated projects are not deletable or editable. Everything is copied over, but when clicking the red "x", nothing happens. Please advise. Thanks, Nate
Posted by Nate 2 years ago
Hello, I am trying to add swagger for a POST request but when I import the url it says "Your swagger file is invalid". Swagger file url : https://cargo-one.herokuapp.com/apidocs/api/v1/quotes.json Is there anything wrong with swagger markdown? Thanks, Ben
Posted by Ben 2 years ago
Hi, is there a way to allow our clients who visit our Online Help Center to not only read help documentation, but also leave a comment? I want to understand if there is a collaboration aspect to Readme since some clients want to chat with us. Thanks, Lindsey
Posted by Lindsey Deane 2 years ago
We have an amazon API gateway setup. All the calls made from outside works fine. But when calls are made from readme.io dashboard, readme.io returns 404 error. I am using AWS API custom domain. With CNAME setup on cloudflare account. CDN is disabled on cloudflare. Proxy option is disabled in reference settings of API endpoint.
Posted by Venzee Admin 2 years ago
When signing up our trial account, the signup process asked what we were interested in documenting; Product or API. For us the answer is both. I choose "Product" to begin with, but I'm wonder what would have been different if I answered "API". Also, are there techniques to be able to have both in the same documentation?
Posted by Mark Goris 2 years ago