Discussions

Hi, I have a readme project where I would like to upload multiple api definitions OAS_v1.yaml OAS_v2.yaml Now I want to show OAS_v2.yaml for those who are logged in, but not to public. Is there a way to customize the UI experience of API references section?

I would like to have the ability to allow users to work with recipes inside my platform without redirect them to the documentation page first (some kind of an embed solution). Is it possible? If not, is it planned to be?

Hi team, previously we were able to scroll down inside a big Response object, but since recently with no changes on our side we are not able to do it anymore are you aware of this issue ? Is there any plan to fix it ? thanks in advance, Mick

Hello! We recently migrated a project into 2 projects. Our mobile SDKs and our Web SDKs were all in a project We moved the SDKs to a new project and left the web documentation in the old project However, when I use the [search feature](https://docs.readme.com/docs/search) on the original project where we now keep our web API documentation, content is displayed in the results that have moved to the new SDK project. The original content URL is being returned as the search result, and the user then sees a 404 error since the content is no longer in that project. Is there a period of time search caches results? It's been several weeks since the project migration. Is there a way to remove these results from showing?

Hello, My OpenAPI spec declares the following type definition: ``` "definitions":{"Foo":{"type":"object","required":...}} ``` Then, some other type ```Bar``` (used as some endpoint body definition) declares 2 fields of this type: ``` "someFoo":{"description":"some foo","$ref":"#/definitions/Foo"} ``` ``` "otherFoo":{"description":"another foo","$ref":"#/definitions/Foo"} ``` When I upload this spec to Readme, open the API page and look at the description of ```Bar```, those two fields are both listed as ```Foo```, instead of ```someFoo``` and ```otherFoo``` (whereas other fields that don't refer to any definition appear with their correct name). Is there a way to change this behavior? Thank you!

What's the recommended way of documenting a TypeScript library in readme? I have a library written in TypeScript and I would like to publish an API reference for it, something like the one for reactjs: <https://react.dev/reference/react>. Up to now, my API reference is generated with typedoc, exported to HTML files and exposed as a web page to the public. Our company policy is to use readme for all documentation related tasks. I tried to exported the API reference to markdown using typedoc plugin and importing it into readme, but the layout doesn't look great and is not readable at all.

Slack integration works for suggested edits but will not send notifications for Discussion questions. Any thoughts on how to fix this?

Nothing worse than taking the time to type up a bunch of feedback only to realize the submit ideas forms is broken, so dropping it here instead: 1. (nice to have) Support for content snippets so content blocks can be reused in multiple places. These are similar to the variables but for lengthier content. 2. (critical) Add a self-help troubleshooting/FAQ section without the ability to comment. Or just disable the ability to comment on the discussions tab. The discussion tab is actually somewhat well suited for this except it doesn't have a more prominent search bar and we don't want to allow for discussions because we don't have the manpower to keep up with that. Users will use it for support tickets and we won't be able to answer and stay on top of that. 3. (important) Add a notifications/announcement page/feed. This is great for seeing upcoming API changes before they happen, broadcast planned changes, mention planned downtime, etc. This would be different than just having a custom page in that it can show an unread notification symbol and re-appear when there's a new message (based on user or if not logged in use local storage). 4. (critical) Within Metrics, I don't just want to see the 400/500 errors. I want to see all calls (200 status codes included). The reason this is important is because the quantity of errors is useless in itself if you don't have the context of the amount of total calls are being made. For example one week endpoint /abcxyz may have 100 calls with 10 returning 400 and the next week there can be 50 calls and again 10 returning 400 errors. The error rate doubled but without the context of the calls made you wouldn't be able to tell. This is important to know for improving the docs. 5. (important) Add the ability to pre-populate parameter inputs WITHOUT needing to use defaults. 6. (critical) When you click the "Try It" button, DO NOT clear the parameter values. This has been a pain point for our users. Honestly surprised this hasn't been done yet. With this you'd also want to add a "clear values" button. 7. (important) The landing page could use better, more modern standard components similar to what is used here: <https://docs.opensea.io/>