8000 Documentation improvements · Issue #1830 · Redocly/redocly-cli · GitHub

More Web Proxy on the site http://driver.im/

Documentation improvements #1830

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.

Sign up for GitHub

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

Jump to bottom

Open

2 of 8 tasks

tatomyr opened this issue Dec 18, 2024 · 1 comment

Labels

Collaborator

tatomyr commented

•

This is a placeholder for relatively small and low-priority CLI documentation issues. Will keep it open and update as I find more.

improve split documentation so it clarifies the intended usage (split command does not support plugins #1822)
explain how to use openapi-core features in JS - https://github.com/Redocly/redocly-cli/blob/main/packages/core/README.md
add explanation about overriding severity of configurable rules
improve eject and other realm-related commands docs (see Ejected components and templates fail with an error about useLocation #1847 (comment))
clarify the filter-in decorator behaviour (filter-in on tags includes operations that don't have a tag #1741)
clarify the merging stragety of root and apis-level config (Merge-resolve per-API with root configuration not fully supported #1871 (comment))
clarify that join doesn't run decorators (Can't use config with the join command #1889 (comment)) since fix: do not execute decorators and preprocessors in join command #1046 and feat: remove --lint, --preprocess, and --decorate options from the join command #1507
TBD

The text was updated successfully, but these errors were encountered:

tatomyr added the Type: Docs label

Contributor

jeremyfiel commented

update docs for Overlay linting, decorators, preprocessors, and type extensions feat: overlay linting, decorators, preprocessors, types extension support #1898

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

0