Redocly / Redocly/redocly-cli

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

Open
#2,069 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Docs
Dominant language
TypeScript
Stars
1.5k
Forks
228
Avg merge
1d 14h
Merged PRs (30d)
48

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the linked CLI, legacy configuration, Redoc configuration, docs/config.md, and the redocly-yaml.ts type definition, starting with schemaDefinitionsTagName. Clarify which features belong to the open-source version and identify the authoritative documentation path. Done means users can reliably find the supported-feature list and understand this option's status.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.