From 9a2a0082bb7902e5158873643cacf5b8f55e9aaa Mon Sep 17 00:00:00 2001 From: Andrew Tatomyr Date: Tue, 20 May 2025 18:33:47 +0300 Subject: [PATCH] docs: remove deprecated CLI commands from docs --- docs/deployment/intro.md | 28 ---------------------------- docs/index.md | 2 +- 2 files changed, 1 insertion(+), 29 deletions(-) diff --git a/docs/deployment/intro.md b/docs/deployment/intro.md index e80b0a0d..55f69d48 100644 --- a/docs/deployment/intro.md +++ b/docs/deployment/intro.md @@ -45,34 +45,6 @@ section in the documentation. If you want to view your Redoc output locally, you can simulate an HTTP server. -#### Redocly CLI - -Redocly CLI is an open source command-line tool that includes a command -for simulating an HTTP server to provide a preview of your OpenAPI definition locally. - -If you have [Redocly CLI](https://redocly.com/docs/cli/#installation-and-usage) installed, `cd` into your -project directory and run the following command: - -```bash -redocly preview-docs openapi.yaml -``` - -Replace `openapi.yaml` in the example command with the file path to your OpenAPI definition. - -By default, without providing a port, the preview starts on port 8080, and can be accessed at `http://localhost:8080`. -To exit the preview, use `control+C`. - -You can alter the port if you are using 8080 already, for example: - -```bash -redocly preview-docs -p 8888 openapi.yaml -``` - -Replace `openapi.yaml` in the example command with the file path to your OpenAPI definition. - -For more information about the `preview-docs` command, refer to -[Redocly CLI commands](https://redocly.com/docs/cli/commands/preview-docs/#preview-docs) in the Redocly CLI documentation. - #### Python If you have [Python 3](https://www.python.org/downloads/) installed, `cd` into your diff --git a/docs/index.md b/docs/index.md index 6e2716e8..d8511505 100644 --- a/docs/index.md +++ b/docs/index.md @@ -85,7 +85,7 @@ theme: Redocly CLI detects a file named `redocly.yaml` in the same directory as you run the command and uses it. See the documentation with a command like this: ```sh -redocly preview-docs openapi.yaml +redocly build-docs openapi.yaml ``` There are many, many more options available. Visit the [configuration reference](./config.md) for a complete list.