Skip to content

Conversation

@adamaltman
Copy link
Member

What/Why/How?

Adds recheck.yaml configuration file.

This doesn't set up GHA or fix the problems.

Steps

  1. Add recheck configuration file
  2. Fix problems
  3. Set up GHA to prevent future problems

Reference

Testing

Summary

   Breakdown by rule:
   semantic-line-breaks: 1897 (1897 errors)
   bullet-style-dash: 453 (453 errors)
   readable-line-length: 338 (338 warnings)
   optimize-images: 116 (116 errors)
   us-spelling: 99 (99 errors)
   no-gerund-headings: 91 (91 errors)
   no-trailing-spaces: 78 (78 errors)
   no-hard-tabs: 36 (36 errors)
   no-duplicate-headings: 32 (32 warnings)
   no-broken-fragment-links: 8 (8 errors)

Screenshots (optional)

Check yourself

  • Code is linted
  • Tested
  • All new/updated code is covered with tests

Security

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

@JLekawa JLekawa self-requested a review December 17, 2025 13:05
Comment on lines +178 to +179
# files:
# - todo
Copy link
Contributor

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?

Copy link
Member Author

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"
Copy link
Contributor

Choose a reason for hiding this comment

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

remove?

Copy link
Member Author

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",
Copy link
Contributor

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?

Copy link
Member Author

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:

  1. Add recheck configuration file
  2. Fix problems
  3. 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.

@adamaltman adamaltman merged commit ea944ca into main Dec 18, 2025
6 checks passed
@adamaltman adamaltman deleted the aa/add-recheck branch December 18, 2025 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants