Redocly

OpenAPI-generated documentation tool with 24k+ stars on Github - make APIs your company's superpower.

Skills

• recheck-config
  Use when you create or tune the recheck block and recheck/* presets in redocly.yaml for a project — choose presets, set severities from measured counts, add exceptions, adopt a baseline, and validate the result.
• recheck-lint
  Use when you write or edit Markdown in a project whose redocly.yaml has a recheck block or a recheck/* preset in extends — run redocly recheck on the touched files before you commit them or hand them over, and fix what it finds.
• redocly
  Set up, write, preview, and publish documentation with Redocly, and work on existing Redocly projects. Use when the user wants to set up Redocly in a repository, create a docs site, document an API from an OpenAPI, AsyncAPI, or GraphQL description, preview docs locally, publish through Reunite, clone a Redocly-hosted project, or run Redocly CLI. Also use when editing a project with redocly.yaml, sidebars.yaml, or a @theme folder, and when unsure which Redocly skill applies.
• redocly-api-docs
  Use when adding or changing API reference docs in a Redocly project: rendering an OpenAPI, AsyncAPI, GraphQL, or SOAP (WSDL) description, its URL and place in the sidebar or navbar, code samples, the Try it (Replay) console, the mock server, x- extensions such as x-tagGroups or x-codeSamples, or embedding one operation or schema in a Markdown page. Not for linting, bundling, or splitting API descriptions (use redocly-cli).
• redocly-authoring
  Use when writing or changing content in a Redocly project: adding, moving, or renaming pages, choosing file names and URLs, links and images, page titles and front matter, Markdoc tags such as admonitions, tabs, cards, code groups, and partials, the sidebar, navbar, and footer, or site settings in redocly.yaml. Not for API reference docs from OpenAPI, AsyncAPI, or GraphQL files (use redocly-api-docs).
• redocly-cli
  Redocly CLI for OpenAPI, AsyncAPI, Arazzo, and Overlay descriptions, and for Markdown docs. Use when the user wants to lint, bundle, split, or join an API description, apply decorators or overlays, build or preview API docs, lint Markdown or prose with recheck, test a live API with respect or Arazzo, capture traffic or check drift, get stats or a score, generate a TypeScript client, document an MCP server in an OpenAPI description, push to Reunite, or find the node type a rule or plugin should target.
• redocly-lint-rules
  Implement a Redocly CLI lint rule in a user's redocly.yaml or custom plugin for an OpenAPI, AsyncAPI, or Arazzo description. Use when the user wants a convention enforced, asks for a configurable rule or a plugin rule, debugs a rule that never reports or gives false positives, or migrates rules from another linter such as Spectral.

How to call

https://redocly.com/a2a

Listed in

Directories this entry was found in.