-
Notifications
You must be signed in to change notification settings - Fork 6
chore: add recheck.yaml file for linting #211
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
Conversation
| # files: | ||
| # - todo |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you plan to add it in this PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When I try to fix the errors in the next PR (not this one).
| - docs/redoc-ce/@v3.x/deployment/html.md | ||
| - docs/public/customization/react-components/list/tag.md | ||
| # lines: | ||
| # - "test this functionality" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably I'll remove it if I don't need it to fix the errors.
| "lint:markdown": "markdownlint-cli2 '**/*.md'", | ||
| "lint:markdown:fix": "markdownlint-cli2 '**/*.md' --fix" | ||
| "lint:markdown:fix": "markdownlint-cli2 '**/*.md' --fix", | ||
| "recheck": "npx @redocly/recheck run --stats", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When is this command run?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right now in my local env. The plan is:
- Add recheck configuration file
- Fix problems
- Set up GHA to prevent future problems
But I want to make it easy for someone to remember how to run recheck because they may not remember the command name run or the options which I always tend to use --stats.
What/Why/How?
Adds
recheck.yamlconfiguration file.This doesn't set up GHA or fix the problems.
Steps
Reference
Testing
Summary
Screenshots (optional)
Check yourself
Security