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

Add documentation for Arazzo rules and linting #1691

Open
DmitryAnansky opened this issue Aug 28, 2024 · 2 comments · May be fixed by #1819
Open

Add documentation for Arazzo rules and linting #1691

DmitryAnansky opened this issue Aug 28, 2024 · 2 comments · May be fixed by #1819
Assignees

Comments

@DmitryAnansky
Copy link
Contributor

DmitryAnansky commented Aug 28, 2024

Describe the bug

New rules for AsyncAPI and Arazzo are not described in config sections like
https://redocly.com/docs/cli/rules/recommended.

We need to update it for all config pages: all, recommended, minimal, strict-recommended.

Also, lest review severity levels in predefined rulesets. Check with @tatomyr and @lornajane

@DmitryAnansky DmitryAnansky added Type: Bug Something isn't working Type: Docs labels Aug 28, 2024
@tatomyr tatomyr removed the Type: Bug Something isn't working label Aug 28, 2024
@lornajane lornajane mentioned this issue Aug 28, 2024
5 tasks
@DmitryAnansky DmitryAnansky self-assigned this Aug 28, 2024
@lornajane
Copy link
Contributor

Also to include with these docs changes:

  • a new top-level configuration entry arazzoRules
  • we'll need additional ruleset documentation for each rule that was added, and for the arazzo version of the minimal/recommended/etc rulesets

@lornajane lornajane changed the title Rules documentation is not updated with latest changes Add documentation for Arazzo rules and linting Aug 29, 2024
@lornajane lornajane added the p2 label Aug 29, 2024
@JLekawa
Copy link
Contributor

JLekawa commented Nov 14, 2024

Blocked until #1800 merges.

@JLekawa JLekawa self-assigned this Nov 14, 2024
@DmitryAnansky DmitryAnansky linked a pull request Dec 9, 2024 that will close this issue
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants