Conversation
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> remoteId: rem_01kys3e4qashawvw3qsa9y2k06 remoteUpdateId: grupd_01kys3e65c0fmxnctj0xh1a0xg branchName: main commitSha: 3016d43022631484d98e811b12d4e6d49ada22a0 commitUrl: Redocly/redocly-cli@3016d43
![redocly[bot]](https://avatars.githubusercontent.com/in/348054?s=60&v=4){kind=small}
There was a problem hiding this comment.
marketing-site AI Review: 🟢 Completed
Note
Low Risk
This PR adds a new documentation file and introduces no behavior or system changes, carrying no operational risk.
Overview
Adds a new @skills/redocly-cli/SKILL.md file documenting guidelines and best practices for using the Redocly CLI. The guide covers the API lifecycle (linting, bundling, transforming, documenting, and testing), redocly.yaml configuration, defining configurable rules, utilizing decorators, building custom plugins, and executing live API tests with Arazzo descriptions. It also includes quick command references, recommended workflows, and common gotchas for developers.
remoteId: rem_01kys3pdsf212cm49mcf1gbe7c remoteUpdateId: rupd_01kys3pdt469wdf39h5j97wwnx
There was a problem hiding this comment.
Remote content mounted at /@skills/redocly-cli/SKILL.md is going to be merged into the main branch.
After merging this pull request, remote content updates will open a new pull request to the target branch and automatically merge it if changes pass Reunite pull request checks.
tatomyr
changed the title
| @@ -0,0 +1,148 @@ | |||
| --- | |||
| name: redocly-cli | |||
| description: Redocly CLI usage for OpenAPI, AsyncAPI, Arazzo, and Overlay descriptions. Use when linting an API description, bundling or splitting multi-file descriptions, joining several APIs into one, transforming a description with decorators, building or previewing API docs, testing a live API with respect to its description. | |||
There was a problem hiding this comment.
If we were to update this, we have to do it in the Redocly CLI repo. It's only a copy. But I'd rather focus on our main areas and not pollute the skill with every possible option. In the end of the day, there are links to the docs where the full capabilites are explained.
DmitryAnansky
left a comment
DmitryAnansky
left a comment
There was a problem hiding this comment.
Left a minor question.
2 participants
Linked the Redocly CLI's skill as a remote content under
/@skills/redocly-clito be accessible for installation withnpx skills add http://redocly.com.