Discussions

I see on this site that there are multiple Guides in the menu navigation (Product Guides and Enterprise Guides) Can someone advise me if/how I can do that on our own site, or does it need a higher plan (We're currently on the startup plan)

Do you have a way to automate responses to questions received on the discussions section? I was thinking perhaps some webhook or something, and then through an API submit a response. Thank you.

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. Does anyone have any recommendations on tools that can read Python docstrings to produce good API documentation hosted on readme?

Hi, excited to try readme. Do you have any tips to auto generate openAPI specs from api endpoints in django rest framework?

<https://preview.readme.io/reference/findPetsByTags> like the example above, i want my response (200/404) to have meaning names such as "successful operation". Where can i change that?

I'd like to retrieve ALL docs in a project. This includes all my reference docs plus any guides and custom pages I've created. Is there a way to do this via the API? I tried using the Search docs endpoint with a wildcard but only got limited results. I don't see a List All Docs endpoint.

Hi, While uploading the Swagger ".json" file on readme.io, I'm facing the below error: [block:image] { "images": [ { "image": [ "https://files.readme.io/448b0ca-image.png", null, null ], "align": "center" } ] } [/block] Relevant JSON block from the Swagger file: ``` "getProductInventorySnapshot": { "type": "object", "properties": { "sku": { "required": true, "type": "string", "example": "TEST-750" }, "upc": { "type": "integer", "example": "816136021655" } } } ``` Based on the requirements, that parameter has to be the "string" type but the error is saying to change it to an array. I'm not sure why. Also, there are already other end-point having params with with "string" type and there is no issue with that. Any help would be appreciated. Thanks

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?

consider \[\<\<coname>>](<<courl>>). The goal is to have a variable for the company name and a variable for the the company's URL. Then when I use them, be able to supply the variable names and have the link work. It seems that variables cannot be active links. It sort of works, however, the published output places the \< symbols around the name-link and the final published output is: <<Analog Informatics Corporation>> And the link points right back to readme, not the link specified in the variable. Is there a way to this? To use variables for the first part and reference it to a link with second variable that works?

It seems readme is only available in a cloud-based server model. Or do you also provide an in-house server model?