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.
Summary
This PR makes these rules more useful to writers by splitting them into meaningful groups and improving the explanations.
Added working links.
Split
Terms.yml
across a few rules so we can better explain why writers see certain recommendations. Here are the rules and their explanations:Accessibility.yml
Recommend.yml
UIConsistency.yml
Wordiness.yml
Terms.yml
I also removed some terms as they either don't make sense (for example, suggesting to replace with the same word), or are unlikely to ever occur in our documentation.
Deleted rules
Renamed
CringeWords
toBestPractice
to avoid implying writing is "cringey".