Improve Hyperlint config to avoid false positives #1036
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
JakeSCahill
commented
Mar 27, 2025
asimms41
reviewed
Mar 27, 2025
Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
|
@JakeSCahill I know I'm late here, but there's also a weirdness with numbers in tables. I think we should have an exception for comments like this: redpanda-data/cloud-docs#228 (comment) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Review deadline: March 27
This pull request includes several improvements to our Hyperlint configuration aimed at reducing false positives and aligning more closely with our Vale checks and custom style guide.
Updates to code formatting guidelines:
.hyperlint/reviewer/custom-style-guide/code-formatting.adoc: Added rules to avoid starting sentences with commands, code, or filenames, and to ignore AsciiDoc include directives. [1] [2]Updates to style guidelines:
.hyperlint/reviewer/custom-style-guide/styles.adoc: Modified the section on notes and warnings to use simpler language and clarified the exception for spelling out numbers. [1] [2]Vale configuration changes:
.hyperlint/reviewer/vale-style-guide/.vale.ini: Disabled specific Google rules for headings and wordlists..hyperlint/reviewer/vale-style-guide/styles/CustomStyle/We.yml: Updated the message to provide clearer guidance on avoiding first-person plural pronouns.Page previews
Checks