Repository navigation
docs(recheck): document the recheck command and update the agent skills - #3182
Merged
Merged
Conversation
…t skills Add a Markdown linting section to the docs: overview, presets, every Markdown rule with its options, the prose assertions and scopes, Markdoc parsing, and ways to suppress findings. Expand the command page and the recheck block reference, and add a guide for migrating from markdownlint and Vale. Update the recheck-lint and recheck-config skills for the redocly.yaml recheck block, keep a copy of them under .claude/skills next to the other skills, and add recheck to the redocly-cli skill.
|
| Name | Type |
|---|---|
| @redocly/cli | Minor |
| @redocly/openapi-core | Minor |
| @redocly/recheck | Minor |
| @redocly/client-generator | Patch |
| @redocly/respect-core | Minor |
| @redocly/reunite-integration | Minor |
Click here to learn what changesets are, and how to add one.
Click here if you're a maintainer who wants to add a changeset to this PR
Contributor
Coverage Report
File CoverageNo changed files found. |
Contributor
Performance Benchmark (Lower is Faster)
|
5 of 7 tasks
RomanHotsiy
approved these changes
Oct 3, 2026
4 of 7 tasks
AlbinaBlazhko17
approved these changes
Oct 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What/Why/How?
The
recheckcommand merged in #3080 with two short docs pages, and the engine's original documentation (the monorepo README) never came with it. This PR documents the command in full and brings the two recheck agent skills up to date with theredocly.yamlconfiguration.Docs
docs/@v2/recheck/: overview and quickstart, presets, every Markdown rule with its options, prose assertions and scopes, Markdoc parsing and schema generation, and ways to suppress findings (file targeting, line exceptions, inline directives, baseline).commands/recheck.mdwith every action, format, and exit code, and an expandedconfiguration/reference/recheck.mdthat explains how presets and the block merge.recheckmoved to its alphabetical place in the commands sidebar.Skills
recheck-lintandrecheck-configupdated for presets in the rootextendsand rules underrecheck.rules, the severity-string versus rule-object distinction, the assertion merge edge,check-config, and the.redocly.recheck-baseline.yamlpickup.packages/recheck/skills/(shipped in the package) and are also copied to.claude/skills/next to the other skills, which is where the website publishes them from. The website still needs remote entries for the two new skills.redocly-cliskill gets arecheckrow and section.Everything is checked against the engine source in this repo, not the monorepo README. Two features of the monorepo engine are not in the CLI yet and are left out of the docs: the
word-count,sentence-count, andreading-timemetric formulas (Redocly/redocly#28017).Reference
Follows #3080.
Testing
markdownlint-cli2with.markdownlint.yamlon every changed Markdown file: clean.markdown-link-checkwith.markdown-link-check.json: no broken links; every intra-doc anchor verified with a script.oxfmt --check: clean.redocly recheckrun on the new pages withrecheck/markdown,recheck/prose, andrecheck/markdoc: the only findings are repo conventions that.markdownlint.yamlalso turns off, plus two engine false positives tracked separately.Check yourself
Security
🤖 Generated with Claude Code
Note
Low Risk
Documentation and agent skill content only; no runtime or CLI code changes in the diff.
Overview
Adds full Markdown and prose linting documentation for
redocly recheck: a newdocs/@v2/recheck/section (overview, presets, Markdown rules, prose assertions, Markdoc, suppression/baseline), a substantially expandedcommands/recheck.md(options, formats, exit codes, CI examples), and richerconfiguration/reference/recheck.mdplus configuration overview links. A new migrate from markdownlint and Vale guide and sidebar/landing-page wiring surface the feature alongside API docs.Agent skills are introduced or refreshed:
recheck-lintandrecheck-configin.claude/skills/andpackages/recheck/skills/, withredocly-cli, README, and changeset notes describing install vianpx skills add. No engine or CLI behavior changes in this diff—docs and assistant guidance only.Reviewed by Cursor Bugbot for commit 6fba241. Bugbot is set up for automated code reviews on this repo. Configure here.