These docs are for v2.0. Click to read the latest docs for v3.0.

Discussions

Ask a Question
ANSWERED

In our api we have a requirement like if there is no object set than need to pass empty array in payload.

Like i need to pass payload like this way for questions and nestedquestions need to pass empty array.

ANSWERED

I used readme previously. It was easier. Why the flow has changed so much?

Could we have like a wizard procedure now?

ANSWERED

Can you place a Hubspot or Zoominfo tracking pixel on a Readme.com doc?

Can you place a Hubspot or Zoominfo tracking pixel on a Readme.com doc?

ANSWERED

I am facing this issue "unknown error(cannot read the properties of null ('reading slug'))" while deploying OAS through github. could someone help me to resolve this issue

I am facing this issue "unknown error(cannot read the properties of null ('reading slug'))" while deploying OAS through github. could someone help me to resolve this issue.

ANSWERED

Potential bug with shared names between guid & api reference categories & pages.

Hi there,

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

How can I configure the project to always show subpages in the sidebar?

Currently, if a user opens the docs generated by readme.com all the pages are collapsed in the sidebar and the user needs to expand the pages to see the subpages. Is there any way to expand all sidebar pages/categories and see all subpages in the sidebar by default?

ANSWERED

Custom javascript button

Is it possible to add a custom javascript button on the left or upper menu?

ANSWERED

Synced OpenAPI definition examples not imported to UI properly

The examples import perfectly and when you go to the top right for an API and click examples it runs, but one of the fields in the main UI when a user can try out the API and fill out the fields will not populate.