Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add cli rules docs #1819

Merged
merged 1 commit into from
Dec 18, 2024
Merged

Conversation

DmitryAnansky
Copy link
Contributor

@DmitryAnansky DmitryAnansky commented Dec 9, 2024

What/Why/How?

CLI rules documentation updates.

Reference

Closes: #1691

Moved docs update from #1697

Testing

Screenshots (optional)

Check yourself

  • Code changed? - Tested with redoc/reference-docs/workflows (internal)
  • All new/updated code is covered with tests
  • New package installed? - Tested in different environments (browser/node)

Security

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

Copy link

changeset-bot bot commented Dec 9, 2024

⚠️ No Changeset found

Latest commit: ed2abd7

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

Copy link
Contributor

github-actions bot commented Dec 9, 2024

Command Mean [ms] Min [ms] Max [ms] Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml 980.2 ± 24.3 948.8 1039.3 1.01 ± 0.03
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml 972.6 ± 13.4 952.8 1002.9 1.00

Copy link
Contributor

github-actions bot commented Dec 9, 2024

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 78.62% 5049/6422
🟡 Branches 67.22% 2053/3054
🟡 Functions 73.16% 834/1140
🟡 Lines 78.91% 4762/6035

Test suite run success

834 tests passing in 121 suites.

Report generated by 🧪jest coverage report action from ed2abd7

@DmitryAnansky DmitryAnansky changed the title chore: add rules docs chore: add cli rules docs Dec 9, 2024
@DmitryAnansky DmitryAnansky requested a review from a team December 9, 2024 14:37
@DmitryAnansky
Copy link
Contributor Author

Moved docs update from #1697.
@JLekawa, please pick it up from here.

@DmitryAnansky DmitryAnansky requested a review from JLekawa December 9, 2024 14:43
docs/rules/recommended.md Outdated Show resolved Hide resolved
docs/rules/minimal.md Outdated Show resolved Hide resolved
docs/sidebars.yaml Outdated Show resolved Hide resolved

- Verbose syntax, where you can configure additional options for rules that support them.
### Spot [ deprecated ]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will remove those rules as soon as I will add support in Spot.

docs/sidebars.yaml Outdated Show resolved Hide resolved
@DmitryAnansky DmitryAnansky marked this pull request as ready for review December 18, 2024 10:44
@DmitryAnansky DmitryAnansky requested a review from a team as a code owner December 18, 2024 10:44
@DmitryAnansky DmitryAnansky force-pushed the chore/update-cli-rules-docuentation branch from d887580 to 6c528f2 Compare December 18, 2024 11:03
@DmitryAnansky DmitryAnansky force-pushed the chore/update-cli-rules-docuentation branch from 6c528f2 to ed2abd7 Compare December 18, 2024 11:05
@DmitryAnansky DmitryAnansky merged commit f6dacce into main Dec 18, 2024
41 checks passed
@DmitryAnansky DmitryAnansky deleted the chore/update-cli-rules-docuentation branch December 18, 2024 11:13
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.

Add documentation for Arazzo rules and linting
3 participants