Discussions

Ask a Question

Displaying H4s in TOC

I know that the TOC is rendered server-side, but is it possible to tweak the CSS/JS in such a way to get it to include H4s? For SEO reasons all of my guides have to start with H2s, so the H4s really act as H3s, and not having them in the TOC makes page navigation harder than I'd like.

intercom search box

Hi When searching docs via intercom messenger we're getting an error. ``` { "support_url": null, "error_code": "third_party_request_error", "message": "Something went wrong with the third party server during the request" } ```

Alternate for API Explorer

Is there any alternate for `https://www.npmjs.com/package/@readme/api-explorer`?

How to make webhook example payloads display by default

Hi there, Can you please help me figure out how to make webhook payloads display by default in our API reference? For example, this is what the payload looks like by default when you open a page: ![](https://files.readme.io/c619469-image.png) You can then click the **EXAMPLES** dropdown and select **Payload Example**: ![](https://files.readme.io/fa0683a-image.png) ...after which, the webhook payloads display as I would expect. They're context-sensitive and update to reflect the webhook selected on the API reference page: ![](https://files.readme.io/69cec5d-image.png) How can I make the 'first' webhook payload display by default and update when different webhooks are selected? The UI isn't too intuitive or appealing to click EXAMPLES, so it would be good to have one preselected so people know it's an interactive section of the page. I'm guessing it's something to do with the OpenAPI specs, but they render just fine in Redocly. Thanks for your help with this!

Does the Owlbot/Ask AI understand emoji in tables?

It seems like, in a table about compatibilities, can it correctly parse something like the following to provide answers: _[header row]_. _Capability Y_ \|\| _Capability Z_ - Software A: ✅ || ❌ - Software B: ❌ || ✅ Would using Git-style emoji shortcodes work better (e.g. :check-mark:) or an image or icon with alt-text?

How to document a custom method

HI! We have custom methods (e.g., `RELOAD`). What should I do to be able to select it in the dropdown when I document a new endpoint? Where to configure it? Thanks a lot!

Ability to ban or delete users

Currently, anyone at anytime can make an account in the Discussions section, and spam the hell out of it. There is no way to prevent this, or stop the spammer from continuing. CAPTCHAs are not a solution, as that does not prevent human driven spam, and the bad actor can do this every day, forever. I'm puzzled how this is not a feature of a public discussion forum. Please make this a thing.

Can you add the ability to export APIs into PDF?

I noticed you can only export Guides, we have lots of internal users asking for PDF exports of the APIs and I have been using <https://www.npmjs.com/package/apibake>, can we get this into the product?

URL encode query parameters in API Reference

My API allows query parameters that can contain special characters (for example, phone numbers with a `+` prefix). When users plug in the string with the special characters into the relevant query param in the API Reference and click "try it!" they expect for the special characters to be encoded correctly into the URL within the generated CURL. Is this a feature we can enable?

Adding a version prompts error: Error submitting form

Hi, When I try to add a new version I'm getting an error 'Error submitting form' without more details for troubleshooting. I'm trying to fork my only other version. Any pointers would be great.