Clean up README and add docs for each analyzer rule #77
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
MattKotsenas
force-pushed
the
feature/clean-up-docs
branch
from
49636e6 to
aa116fb
Compare
rjmurillo
approved these changes
Jun 10, 2024
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.
Made a pass at the README and other docs to make the project easier to use.
CODE-OF-CONDUCT.mdso that GitHub can pick it up automatically and add it to the UICONTRIBUTING.mdso that GitHub can pick it up automatically and add it to the UI//docs/rules/folder and added a doc per rule with an explanation and sample