Skip to content

chore: add cookbook#2956

Merged
DmitryAnansky merged 11 commits into
mainfrom
feat/add-cookbook-to-monorepo
Jul 23, 2026
Merged

chore: add cookbook#2956
DmitryAnansky merged 11 commits into
mainfrom
feat/add-cookbook-to-monorepo

Conversation

@DmitryAnansky

@DmitryAnansky DmitryAnansky commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

What/Why/How?

Added cookbook to the redocly/cli monorepo.

Reference

Redocly/redocly-cli-cookbook#55

Testing

Screenshots (optional)

Check yourself

  • This PR follows the contributing guide
  • All new/updated code is covered by tests
  • Core code changed? - Tested with other Redocly products (internal contributions only)
  • New package installed? - Tested in different environments (browser/node)
  • Documentation update has been considered

Security

  • The security impact of the change has been considered
  • Code follows company security practices and guidelines

Note

Low Risk
Adds documentation and example configs only; cookbook is explicitly outside the CLI build and test suite, with no runtime package changes.

Overview
Adds a new cookbook/ tree — a community catalog of copy-pasteable rulesets, configurable rules, custom plugins (rules and decorators), and misc utilities, each with READMEs and sample redocly.yaml / OpenAPI where relevant.

Contributor and CI updates: CONTRIBUTING.md documents how to add cookbook entries (no changeset; use no changeset needed). Docs workflows lint cookbook/**/*.md with markdownlint and run link checks on ./cookbook in addition to ./docs.

Reviewed by Cursor Bugbot for commit 09607e4. Bugbot is set up for automated code reviews on this repo. Configure here.

@changeset-bot

changeset-bot Bot commented Jul 21, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 09607e4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

@github-actions

github-actions Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 71.97% (🎯 69%) 8676 / 12055
🔵 Statements 71.65% (🎯 69%) 9027 / 12598
🔵 Functions 76.63% (🎯 73%) 1719 / 2243
🔵 Branches 63.48% (🎯 61%) 5844 / 9205
File CoverageNo changed files found.
Generated in workflow #10825 for commit 09607e4 by the Vitest Coverage Report Action

@github-actions

github-actions Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Performance Benchmark (Lower is Faster)

CLI Version Bundle Lint Check Config
cli-latest ▓ 1.00x ± 0.01 ▓ 1.00x ± 0 ▓ 1.00x (Fastest)
cli-next ▓ 1.00x (Fastest) ▓ 1.00x (Fastest) ▓ 1.00x ± 0.02

@DmitryAnansky
DmitryAnansky marked this pull request as ready for review July 21, 2026 15:40
@DmitryAnansky
DmitryAnansky requested review from a team as code owners July 21, 2026 15:41
Comment thread cookbook/configurable-rules/operation-deprecated-response-headers/redocly.yaml Outdated
Comment thread cookbook/custom-plugin-decorators/remove-extensions/remove-extensions.js Outdated
Comment thread cookbook/custom-plugin-decorators/tag-sorting/decorator-alpha.js
Comment thread cookbook/custom-plugin-decorators/apply-root-security/decorator.js Outdated
Comment thread cookbook/custom-plugins/sorting/rule-sort-methods.js Outdated
Comment thread cookbook/custom-plugin-decorators/update-example-dates/decorator.js
Comment thread cookbook/rulesets/security/redocly.yaml Outdated
Comment thread cookbook/configurable-rules/operation-operationId-exclude-OPTIONS/redocly.yaml Outdated
Comment thread CONTRIBUTING.md
@DmitryAnansky
DmitryAnansky requested a review from Daryna-del July 22, 2026 15:47
Comment thread cookbook/custom-plugin-rules/code-sample-checks/x-code-sample-checks.js Outdated
Comment thread cookbook/configurable-rules/operation-deprecated-response-headers/openapi.yaml Outdated
Comment thread cookbook/custom-plugin-decorators/apply-root-security/decorator.js
Comment thread cookbook/custom-plugins/sorting/rule-sort-props.js
Comment thread cookbook/configurable-rules/operation-deprecated-response-headers/openapi.yaml Outdated
Comment thread cookbook/rulesets/common-mistakes/redocly.yaml Outdated
Comment thread cookbook/custom-plugin-rules/code-sample-checks/check-sdk-coverage.js Outdated
Comment thread .github/workflows/docs-tests.yaml

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 3 potential issues.

There are 4 total unresolved issues (including 1 from previous review).

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 7e0596d. Configure here.

Comment thread cookbook/configurable-rules/api-health/redocly.yaml
Comment thread cookbook/custom-plugin-decorators/apply-root-security/decorator.js
Comment thread cookbook/custom-plugins/sorting/sort-props-required.js
@DmitryAnansky
DmitryAnansky merged commit 129a5a8 into main Jul 23, 2026
44 of 45 checks passed
@DmitryAnansky
DmitryAnansky deleted the feat/add-cookbook-to-monorepo branch July 23, 2026 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants