Discussions
Is there a way to link from one glossary definition to another?
For example, I have a term that really should point the user to another term, such as "User" and "User ID". If I use the "<<glossaryterm>> within a glossary definition, the reference does not work. At the very least I'd like to be able to write "See Also: <<glossaryterm>>" and have that link to the other glossary. Additionally, I'd like to be able to display my entire glossary to the user as a page. Is that possible?
Posted by Charity Dominic over 1 year ago
Refreshing/side nav is too laborious
Every time I edit something that affects the side nav, I have to refresh and when I do that I am returned to the top of the side nav and often have to spend some time hunting for where I left off in that nav. Sometimes, I get interrupted at that moment and totally lose my place and forget what I was doing so this is risky to my authoring process. Two things that would reduce the time and effort here: 1) Refresh the site whenever I save edits to a page that affects the side nav (a prompt to do that would be fine), and 2) Hold my place in that nav when refreshing.
Posted by Charity Dominic over 1 year ago
Hide Recipes
Is it possible to hide the Recipes menu option if I don't want to use it?
Posted by Charity Dominic over 1 year ago
How do I redirect Readme pages to an external site?
Hi,
We're looking to redirect our pages to another docs site. How do I set this up and can we do page to page redirects? Or, can redirection only be done to the readme homepage where we're publishing our docs to? If I can get some info about this, it would be helpful. Thanks!
Posted by Urvi Shah over 1 year ago
Why does the API URL title on the sidebar of my API documentation keep changing?
I keep changing the title from API URL to API Documentation because I wanted to change the way it looked and it keeps returning back to API URL. I change the text, it saves it automatically and then I check on the preview of my documentation site, but when I come back the next day, it is back to API URL. I am the only person writing API documentation and none of the other two on my account have changed anything. What's going on? Am I not supposed to change that text?
Posted by Christopher Fernandez over 1 year ago
Enhancement request
In the try it provide a way to set global header values so that you don't have to cut and paste into every endpoint that you want to try.
Posted by Don Glover over 1 year ago
How do I enable anonymous access to my help pages?
I am planning to login some customers for advanced features (API-related), but I don't want people to have to log in at all just to see the guides.
Posted by Steven Thomas over 1 year ago
Viewing API Call metrics by API key not working?
In the metrics view, I see an option to view API calls by users, either by entering their email or their API Key. When I entered the API key I see a user sending, nothing shows up in the API calls graph, though I can see that they're using that key in the request headers. Is this a bug on readme's system or is there something I'm doing wrong? It would be very helpful to view calls by API Key given that many of our users arent logged in with email addresses.
Posted by Hannah over 1 year ago
Search results appearing for content no longer in a project
Hello! We recently migrated a project into 2 projects.
Our mobile SDKs and our Web SDKs were all in a project
We moved the SDKs to a new project and left the web documentation in the old project
However, when I use the [search feature](https://docs.readme.com/docs/search) on the original project where we now keep our web API documentation, content is displayed in the results that have moved to the new SDK project. The original content URL is being returned as the search result, and the user then sees a 404 error since the content is no longer in that project.
Is there a period of time search caches results? It's been several weeks since the project migration. Is there a way to remove these results from showing?
Posted by Kristen Jourdonais over 1 year 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