Discussions

Sync Docs to GitHub When Making Edits in ReadMe

Is there a way to connect our product Doc markdown files to GitHub when we make edits in the ReadMe platform? Our team wants to ensure we have records in multiple places and I am having trouble figuring out how to set it up?

Posted by Haley almost 2 years ago

ANSWERED

Discussion Tags

Can an end-user non-admin add a tag to their questions?

Posted by Josue almost 2 years ago

ANSWERED

Bug: page title double encoding

If I use an apostrophe in the title in a guide page metadata, it turns into ' in the browser tab title on the guide public page. It happens because the title is HTML-escaped 2 times, therefore I get the result of the first escaping in the browser tab.

Posted by Sergey almost 2 years ago

ANSWERED

API reference of an TypeScript library

What's the recommended way of documenting a TypeScript library in readme?

Posted by Pawel Zieba almost 2 years ago

ANSWERED

Can Recipes be programmatically added?

If I wanted to add a recipe programmatically, is there a way to do that?

Posted by Jeanette almost 2 years ago

ANSWERED

Pass JWT/API Key in request body via POST for Custom Login

In the https://docs.readme.com/main/docs/custom-login-page example, we're shown an example of passing the JWT through the URL when redirecting back to a project's docs page. Is there support for passing this data through a POST request body? Or any other ways outside of including the token in the URL params?

Posted by Samuel Yeo almost 2 years ago

Replace example.com in api sync

Similarly to this issue, I am using an autogenerated openapi file from FastAPI, and don't see why there isn't an easy way to manually set the api endpoint for the generated docs, or at least sync with whatever endpoint the openapi file is retrieved from. This feature is blocking us from using the built-in request flow, a pretty big issue for our users. Is there any fix coming or available?

Posted by Ben Rosand almost 2 years ago

ANSWERED