From 1aa6847d1dc7bac1953955d03399cc93c1f8881e Mon Sep 17 00:00:00 2001 From: Matt Van Horn Date: Fri, 17 Apr 2026 01:16:05 -0400 Subject: [PATCH] docs: add missing guides to CLI guides landing Closes #1519 --- docs/@v1/guides/index.md | 42 +++++++++++++++++++++++++++++++++++ docs/@v2/guides/index.md | 48 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 90 insertions(+) diff --git a/docs/@v1/guides/index.md b/docs/@v1/guides/index.md index 328254041a..fff7a39d3a 100644 --- a/docs/@v1/guides/index.md +++ b/docs/@v1/guides/index.md @@ -73,4 +73,46 @@ How to change the OAuth2 token URL. How to create a custom decorator to hide OpenAPI specification extensions. {% /card %} +{% card title="Configure API linting rules" + to="./configure-rules" + %} +Combine built-in and custom rules to match your API's standards. +{% /card %} + +{% card title="Set up tab completion" + to="./autocomplete" + %} +Generate shell completions for the `redocly` command. +{% /card %} + +{% card title="Update Redocly CLI" + to="./update-cli" + %} +Keep your Redocly CLI installation current with the latest features and fixes. +{% /card %} + +{% card title="Migrate from openapi-cli" + to="./migrate-from-openapi-cli" + %} +Upgrade from the deprecated openapi-cli by replacing it with `redocly`. +{% /card %} + +{% card title="Migrate from redoc-cli" + to="./migrate-from-redoc-cli" + %} +Replace the legacy redoc-cli commands with Redocly CLI equivalents. +{% /card %} + +{% card title="Migrate from Spectral" + to="./migrate-from-spectral" + %} +Switch from Spectral to Redocly CLI's linting and tooling. +{% /card %} + +{% card title="Migrate from swagger-cli" + to="./migrate-from-swagger-cli" + %} +Replace the deprecated swagger-cli package with Redocly CLI. +{% /card %} + {% /cards %} diff --git a/docs/@v2/guides/index.md b/docs/@v2/guides/index.md index 57a420615d..5b89646bcf 100644 --- a/docs/@v2/guides/index.md +++ b/docs/@v2/guides/index.md @@ -79,4 +79,52 @@ How to change the OAuth2 token URL. How to create a custom decorator to hide OpenAPI specification extensions. {% /card %} +{% card title="Configure API linting rules" + to="./configure-rules" + %} +Combine built-in and custom rules to match your API's standards. +{% /card %} + +{% card title="Set up tab completion" + to="./autocomplete" + %} +Generate shell completions for the `redocly` command. +{% /card %} + +{% card title="Update Redocly CLI" + to="./update-cli" + %} +Keep your Redocly CLI installation current with the latest features and fixes. +{% /card %} + +{% card title="Migrate to Redocly CLI v2" + to="./migrate-to-v2" + %} +Essential changes when upgrading from v1.x to v2.x. +{% /card %} + +{% card title="Migrate from openapi-cli" + to="./migrate-from-openapi-cli" + %} +Upgrade from the deprecated openapi-cli by replacing it with `redocly`. +{% /card %} + +{% card title="Migrate from redoc-cli" + to="./migrate-from-redoc-cli" + %} +Replace the legacy redoc-cli commands with Redocly CLI equivalents. +{% /card %} + +{% card title="Migrate from Spectral" + to="./migrate-from-spectral" + %} +Switch from Spectral to Redocly CLI's linting and tooling. +{% /card %} + +{% card title="Migrate from swagger-cli" + to="./migrate-from-swagger-cli" + %} +Replace the deprecated swagger-cli package with Redocly CLI. +{% /card %} + {% /cards %}