Fix custom rule to allow for sentences to start with a link to a command or file when preceded by an article #1027
Conversation
This file contains hidden or 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
…and or file when preceded by an article
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
JakeSCahill
added a commit
that referenced
this pull request
Apr 3, 2025
…and or file when preceded by an article (#1027)
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 24
This pull request includes updates to the code formatting guidelines and enhancements to the meaningful link text style guide. The most important changes include improving the structure and clarity of the code formatting guidelines and expanding the list of non-descriptive link texts to avoid.
Improvements to code formatting guidelines:
.hyperlint/reviewer/custom-style-guide/code-formatting.adoc: Enhanced the guidelines by providing clearer examples of correct and incorrect usage of commands, filenames, and xrefs in sentences.Enhancements to meaningful link text style guide:
.hyperlint/reviewer/vale-style-guide/styles/CustomStyle/MeaningfulLinkText.yml: Added more patterns to thetokens:list to avoid non-descriptive link texts, specifically forxreflinks.Page previews
Checks