Discussions

Ask a Question
ANSWERED

Discussions webhook?

Does readme support a webhook to notify when a new discussion question / response is posted?

ANSWERED

Control code block size

Is there any way to control the size of a code block and force it to wrap the code with in it? I have a JSON code example that's making the code block too wide for my page.

ANSWERED

How to remove auto generated examples

Hi, we are using an OpenAPI schema to create our API reference on Readme. We find that the auto generated language examples often confuse our users or put them on the wrong track (we'd prefer developers use our own SDK).

ANSWERED

Discussion Forum Moderation

We are considering enabling the Discussion feature. Does it have a way to moderate discussion posts before they appear publicly?

ANSWERED

Getting error in validate command

While executing rdme openapi:validate command we are getting error SyntaxError: Unexpected token 'with' Exit Code : 1 in workflow output.

Looking for recommendations for automatic Python API (docstring) to readme.io markdown pages

We host our API documentation on readme (see here: https://docs.edgeimpulse.com/reference). While we use the OpenAPI integration for our REST API, we are also working on generating and hosting Python API documentation for our Python SDK. At the moment, I have been learning and tinkering with sphinx and pydoc-markdown for markdown generation. Neither seems to provide the output required for readme without modifications to their code or some custom add-ons.

ANSWERED

Suggest edits not available for /refecence pages

Why is "Suggest edits" not visible for pages in the API Reference?

ANSWERED

Anyone using the Search API?

Hi, We're using api/v1/docs/search to return docs on a custom page outside of readme (wordpress). We're using 3 readme.io projects, making 3 API calls to return results.

Deleting a version

Hi Community,

ANSWERED

Table overflow on page

Hello all,