Discussions

Ask a Question
ANSWERED

Is it possible to export one document (e.g. as html) and then import the translation versions?

We're like to translate one existing document managed by ReadMe, and would like to export resource English files for translation, and then import the translated files back to the tool to make language versions. Is it possible? If so, could you please suggest how shall we proceed? I read documents related to Localize but it's not something we'd like to integrate, and we'd like to work with our own translation vendor(s) instead.
ANSWERED

Changing the page slug does not seem to update cross-reference hyperlinks

If I change the page slug, links I created to that page from other pages are broken. If it is not possible to automatically update those links when I change the slug, I need a report of the broken links so I can go fix them.
ANSWERED
ANSWERED

Is there a way to use a glossary term in a variable definition?

For example, I'm using variables to house basic, one-paragraph definitions for each of our API endpoints. They use glossary terms. When I copy and paste the paragraph from a page into a variable definition field, the glossary term does not work.
ANSWERED

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?

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.
ANSWERED

Hide Recipes

Is it possible to hide the Recipes menu option if I don't want to use it?
ANSWERED

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!

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?
ANSWERED

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.