8000 What is the correct place to see features supported in redocly-cli opensource version · Issue #2069 · Redocly/redocly-cli · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
huima opened this issue Apr 25, 2025 · 1 comment

Comments

@huima
Copy link
huima commented Apr 25, 2025

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:

schemaDefinitionsTagName: { type: 'string' },

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

@adamaltman
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants
0