docs: plain-language READMEs - #43
Merged
Merged
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Rewrites every README for someone new to the provider: what the rule catches and why it matters first, then examples, then the detail of what exactly counts under its own heading. Same shape in every file, one short ignoring section instead of two duplicated ones, and the AZS004/AZS006/AZG007 flag sections folded into their options tables. The root README gets a quick start, a short glossary of provider terms, and the ignoring section ahead of the golangci setup.
Badge row and lowercase workflow names match katbyte/tctest#138, minus the OpenSSF badge. Also fixes the one typos hit on main: the AZR009 keep regex used the prefix
skipp, nowskip.