Discussions

Ask a Question

Reusable content does not show in TOC

Hi Each page under **Guides** shows a small **table of contents** (_top, right_), based on the **page headings**. I notice, however, that headings from a **reusable content snippet** do **not** show up there. Is that something that Readme is planning to address? **Motivation**: Sometimes, we want to create a chunk of reusable content that includes headings. But bc of this limitation, we are forced to break it into smaller chunks, and leave the headings as fixed text. Thanks PS: The reusable content is a _very_ welcome feature. Great job! 👍

Recover deleted API reference page

I deleted an API reference page as I generated a new one using a different schema for the endpoints. But the old page had manual docs explaining each of the response fields and is now gone. I need these same docs fo the new page. Any way that you can recover this for me ? It just happened less than an hour ago.

Segment Integration sends wrong data

Hi The readme/segment integration sends the `page path` as the "category" name. Any chance to adjust send the actual Category Name? ```javascript analytics.page('/docs/what-is-anytrack', 'What is AnyTrack?', { category: '/docs/what-is-anytrack', context: { plugin: { name: 'readme_io', version: '1.0.0' } }, name: 'What is AnyTrack?', path: '/docs/what-is-anytrack', referrer: '', search: '?_cio_id=d6a4050080df0182df01&ajs_aid=d6a4050080df0182df01&ajs_event=Clicked%2520Email&ajs_prop_emailCampaign=Free+trial&ajs_uid=PpouT09lhq&atclid=p8qkMansHXKGxAZjAgbldrxzDSq53R&utm_campaign=Free+trial&utm_content=Unusual+welcome+Email+%28Samuel+Edit%29&utm_id=30&utm_marketing_tactic=email_action&utm_medium=email&utm_source=customer.io', title: 'What is AnyTrack?', url: 'https://readme.anytrack.io/docs/what-is-anytrack' }); ```

How do we change our name from `null` in discussions when logged in?

I understand we can edit our profile via the readme.com dashboard but this does not change the name in when posting in discussions (currently null). Anyone know how to set our default name for all README discussions? Thank you in advance!

Try now button

I have imported a OAS file which automatically enabled Try Now button for all endpoints. I understood that I can can turn it off by setting the OpenAPI extension x-explorer-enabled to false. But, with the design our documentation page will be visible to everyone, regardless logged in or not. So I am curious how to handle the case when users not signed in yet my platform so no api key can be retrieved.

Is there a workaround for supporting "anyOf" in readme?

I am working to port over our docs and we use anyOf for an object type. Does readme support that structure? if not is there a workaround? Also I am noticing that nested references within components/schemas are not rendering correctly. eg: ``` Components: Schemas: schema1: title: "a" schema2: title: "b" variable1: ref: "#/components/schemas/schema1" schema2: title: "c" variable2: ref: "#/components/schemas/schema2" ``` Based on the above example, the API Reference does not render the details of nested schema from references, I,e schem2.variable1 is listed as an empty field and does not fully render the details of schema1 Is this expected behavior? Is there a way to help with this nesting issue? Our documentation has a lot of this type of nesting.

How to provide the OpenAPI specification to the customers?

Hi, we want to share the OpenAPI specification publicly with our customers. We see that there is a public link for it("view oas"), but this link is not permanent across API versions. Could you please advise us on how to achieve what we want? The feature is much needed because some developers still prefer to import the file in Postman.

Customing Tags in OAS

Pages are created when we specify `tags` in our OAS, but I wanted to add more information on this page, ideally a markdown. Is there a way for us to do this via CLI?

Expanding search limitations

Are there any plans to expand the search limitations on Algolia searches? I want to use collapsible sections in my guides, but can't because of the way the search ignores content wrapped in raw HTML. I know you can assign keywords for SEO metadata, but do those keywords also come up in search results within my product guides? I'd love to not have to choose between lots of scrolling and ensuring searches return the expected results.

Performance issues - How to pass Core Web Vitals

We'd like to move to ReadMe but have concerns about performance of the ReadMe platform and failing Core Web Vitals. This is important given we need to be able to drive organic search traffic to our documentation and will be more critical in March 2024 when Google replaces FID with Interaction to Next Paint (INP). Is this a known issue and are there any recommendations to be able to get a ReadMe powered site to pass Core Web Vitals? <https://docs.readme.com> fails and other sites known to use ReadMe have even poorer metrics ![](https://files.readme.io/7e63b6b-image.png)