Discussions

Could we have like a wizard procedure now?

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

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. As a developer, I am working on documentation for API changes. Due to support of multiple base URL's, I upgraded to OAS 3.0 from OAS 2.0. After that I started facing this issue. If i update readme keys (API_DEFINITION_KEY & Readme key), then the build is successfull. But after deploying few more changes suddenly this issue replicating. I did validating my OAS file using swagger editor and no error in it. could you pleae reproduce this isssue on your side and provide me the solution.

Hi there, My name is Alexander, I'm a developer from FundApps. I am currently looking at using readme to consolidate our implementation and I noticed a couple of issues in playing around. If you create a category with the same name as an API reference that the admin window gets into a broken state where it becomes difficult to move pages and delete categories. Similarly if you duplicate page names between your api reference and your guide, the api reference page appears in the guide. Are these intended behaviours? It comes across to me like a potential issue if you are syncing documentation across 2 or more Github repositories (which don't have knowledge of the page titles between repositories). The first issue we can be careful about, but the second is harder to ensure safety. Otherwise I am super keen on using ReadMe and will be presenting to my company! Thanks, Alex

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, I am trying to set the Personalized Docs Webhook for my application. I added enpoint and served it with ngrok. I tested that endpoint through the Postman and it's giving me correct result. It's working. Here is the CURL: curl --location --request POST '<https://8407-85-114-46-238.eu.ngrok.io/webhook>' --header 'Content-Type: application/json' --data-raw '{ "email": "test" }' But when I test it in the 3. step of Personalized Docs I am getting: Endpoint not found! Did you forget the path in your server URL (e.g., /webhook)? With Network response: 400 status code and json response {type: "not-found"} Can you provide me more information about why am I getting this response?

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?

Is it possible to add a custom javascript button on the left or upper menu? I have a widget that I want to be executed when somebody clicks on the menu item.

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. Usually the examples are accurate and populate so that the user can try it without having to click on the top right examples request button. I'd add photos if possible, but seems like the forum is only text.

readmeio SDK is not supported in Golang. Can I create my own method that will verify the readme signature? I can take it from request and then compare to my readme secret taken from env variable I suppose. But which hashing algorithm should I use to compare these values? I added a feature request for supporting the Golang... I am not sure if this is something that will be implemented in the near future but If not - I would like a way to do this.