redocly-cli icon indicating copy to clipboard operation
redocly-cli copied to clipboard

What is the correct place to see features supported in redocly-cli opensource version

Open huima opened this issue 8 months ago • 2 comments

I am having trouble understanding what features are available in the open-source version and basically feel like there is a need to just test things out.

If I start from the page: https://redocly.com/docs/cli/commands/build-docs

It then links to configuration options on two pages:

  1. https://redocly.com/docs-legacy/api-reference-docs/configuration/functionality
  2. https://redocly.com/docs-legacy/api-reference-docs/configuration/theming

On the second page it is clearly marked which features are supported in community version with ". Supported in Redoc CE"

But on the first page there is a link to look at opensource Redoc configuration: https://redocly.com/docs/redoc/config

On the opensource version page there is no mention of schemaDefinitionsTagName but it seems to work with the redocly-cli if I just use it.

Then again in the Redoc repo docs directory it is listed in the config: https://github.com/Redocly/redoc/blob/main/docs/config.md

theme: openapi: schemaDefinitionsTagName: Schemas

I can see it in the types desciption too: https://github.com/Redocly/redocly-cli/blob/076784b97e502e5c0ce160bd9ad7a9c685865315/packages/core/src/types/redocly-yaml.ts#L1060

So just wondering how to improve the user experience and understand where to look.

huima avatar Apr 25 '25 11:04 huima

We'll look into it -- it looks like a docs issue.

adamaltman avatar May 01 '25 15:05 adamaltman

You can also find a list of available commands directly on the command line.

Image

jeremyfiel avatar May 13 '25 01:05 jeremyfiel