Skip to content

docs: add missing guides to CLI guides landing #2747

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

Open
mvanhorn wants to merge 1 commit into
base: main
Choose a base branch
from
+90 −0
Open

docs: add missing guides to CLI guides landing #2747

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions docs/@v1/guides/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
48 changes: 48 additions & 0 deletions docs/@v2/guides/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
Loading