From babcb2919e9d78b189e59af9ab319e989cb64388 Mon Sep 17 00:00:00 2001 From: Lorna Mitchell Date: Thu, 3 Aug 2023 14:17:01 +0100 Subject: [PATCH] docs: Remove Redoc CLI and a non-existent config option --- README.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a98459303f..364bc30bcc 100644 --- a/README.md +++ b/README.md @@ -136,11 +136,11 @@ Additionally, all the 1.x releases are hosted on our GitHub Pages-based CDN **(d ## Lint OpenAPI definitions -Redocly's CLI is an [open source command-line tool](https://github.com/Redocly/redocly-cli) that you can use to lint +Redocly CLI is an [open source command-line tool](https://github.com/Redocly/redocly-cli) that you can use to lint your OpenAPI definition. Linting helps you to catch errors and inconsistencies in your OpenAPI definition before publishing. -Refer to [Redocly configuration](https://redocly.com/docs/cli/configuration/) in the OpenAPI documentation for more information. +Learn more about [API standards and linting](https://redocly.com/docs/cli/api-standards/) in the main Redocly documentation. ## Deployment @@ -181,10 +181,6 @@ For step-by-step instructions for how to get started using Redoc to render your OpenAPI definition, refer to the [**Redoc quickstart guide**](https://redocly.com/docs/redoc/quickstart/) and [**How to use the HTML element**](https://redocly.com/docs/redoc/deployment/html/). -## Redoc CLI -For more information on Redoc's command-line interface, refer to -[**Using the Redoc CLI**](https://redocly.com/docs/redoc/deployment/cli/). - ## Configuration @@ -234,7 +230,6 @@ You can use all of the following options with the standalone version of the 50). In this mode ReDoc shows initial screen ASAP and then renders the rest operations asynchronously while showing progress bar on the top. Check out the [demo](\\redocly.github.io/redoc) for the example.~~ * `menuToggle` - if true, clicking second time on expanded menu item collapses it, default `true`. * `nativeScrollbars` - use native scrollbar for sidemenu instead of perfect-scroll (scrolling performance optimization for big specs). * `onlyRequiredInSamples` - shows only required fields in request samples.