mirror of
https://github.com/LukeHagar/redocly-cli.git
synced 2025-12-10 04:21:20 +00:00
0455569a39
* docs: Start with a more developer and purpose oriented landing page * docs: Clear installation options, autocomplete is a separate guide * docs: update links in installation guide * docs: Move update instructions to be a guide, remove local installation * docs: Remove git documentation from starter project * docs: Add a quicker quickstart * docs: Re-organise and flesh out commands page * docs: add built-in ruleset docs, add concept, start guide * docs: Add a guide for configuring linting * Docs: rename custom rules to assertions * docs: Sort assertion docs and examples alphabetically * docs: clearer linting explanations and signposting of rule types * Apply suggestions from code review Co-authored-by: Adam Altman <adam@redoc.ly> * docs: Remove reference to a config object, after user confusion * docs: Add docs-building entrypoint article * docs: Add one-line descriptions alongside rule names * fix: Correct images for docs overview page * docs: Link to custom function in custom plugin docs * fix: Links in rules need updating after this file moved * docs: Add concept article for openapi file wrangling * docs: assertions are now called configurable rules * fix: Broken links and a renamed file * docs: Titles, links, and restructuring * Apply suggestions from code review Co-authored-by: Adam Altman <adam@redoc.ly> * fix: Redirect for renamed CLI update guide * Apply suggestions from code review Co-authored-by: Adam Altman <adam@redoc.ly> * chore: reduce filesize of images * docs: Detangle the custom/configurable rules vs assertions confusion * fix: labels as well as links to configurable rules * Update docs/guides/configure-rules.md Co-authored-by: Adam Altman <adam@redoc.ly> * fix: Better example wording and fix title case * Update docs/commands/index.md Co-authored-by: Adam Altman <adam@redoc.ly> * Update docs/rules/recommended.md Co-authored-by: Adam Altman <adam@redoc.ly> * Update docs/quickstart.md Co-authored-by: Adam Altman <adam@redoc.ly> * Update docs/rules.md Co-authored-by: Adam Altman <adam@redoc.ly> * chore: rename file built-in-rules.md and corresponding links (#1075) --------- Co-authored-by: Adam Altman <adam@redoc.ly>
37 lines
1.4 KiB
Plaintext
37 lines
1.4 KiB
Plaintext
---
|
|
title: Redocly CLI guides
|
|
description: Browse how-to guides for working with Redocly CLI
|
|
---
|
|
|
|
import { WideTile, Flex } from '@redocly/developer-portal/ui';
|
|
|
|
# Redocly CLI guides
|
|
|
|
A selection of guides to common tasks with Redocly CLI.
|
|
|
|
<div>
|
|
<Flex justifyContent="space-between" flexWrap="wrap">
|
|
<WideTile to="../quickstart.md" header="Redocly CLI quickstart">
|
|
Take your first steps with Redocly CLI.
|
|
</WideTile>
|
|
<WideTile to="../openapi-starter.md" header="OpenAPI starter project">
|
|
Get started with OpenAPI and Redocly, using this sample project.
|
|
</WideTile>
|
|
<WideTile to="./response-contains-property.md" header="Enforce response contents">
|
|
How to create a custom rule to enforce response contents.
|
|
</WideTile>
|
|
<WideTile to="./hide-apis.md" header="Hide internal APIs">
|
|
How to hide internal APIs.
|
|
</WideTile>
|
|
<WideTile to="./replace-servers-url.md" header="Replace the server URL">
|
|
How to replace the server URL in different environments.
|
|
</WideTile>
|
|
<WideTile to="./change-token-url.md" header="Change the OAuth2 token URL">
|
|
How to change the OAuth2 token URL.
|
|
</WideTile>
|
|
<WideTile to="./hide-specification-extensions.md" header="Hide OpenAPI specification extensions">
|
|
How to create a custom decorator to hide OpenAPI specification extensions.
|
|
</WideTile>
|
|
</Flex>
|
|
</div>
|