Introduce rule documentation #26
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
|
👋 Hello and thanks for pinging us! An accessibility first responder will review this soon.
|
JoyceZhu
reviewed
Dec 27, 2022
| ``` | ||
|
|
||
| ```md | ||
| <!-- Mark decorative images with an empty string --> |
There was a problem hiding this comment.
was this comment supposed to go above the first "correct" example?
There was a problem hiding this comment.
Indeed, thanks for catching. Fixed!
JoyceZhu
reviewed
Dec 27, 2022
JoyceZhu
reviewed
Dec 27, 2022
Co-authored-by: Joyce Zhu <joycezhu@github.com>
Co-authored-by: Joyce Zhu <joycezhu@github.com>
khiga8
commented
Dec 28, 2022
| "scripts": { | ||
| "publish": "npm publish --access public --@github:registry=https://registry.npmjs.org", | ||
| "test": "npm run lint && jest", | ||
| "lint": "markdownlint-cli2 \"**/*.{md,mdx}\" \"!node_modules\" \"!test/example.md\" && eslint .", | ||
| "lint": "markdownlint-cli2 \"**/*.{md,mdx}\" \"!node_modules\" \"!docs/rules\" \"!test/example.md\" && eslint .", |
There was a problem hiding this comment.
I am excluding our docs because I don't want it to flag our "incorrect' usecase rules. 😅
ericwbailey
approved these changes
Dec 28, 2022
Comment on lines
+15
to
+21
| ```md | ||
|  | ||
| ``` | ||
|
|
||
| ```md | ||
| <img alt="Screen Shot 2022-06-26 at 7 41 30 PM" src="https://user-images.githubusercontent.com/abcdef.png"> | ||
| ``` |
There was a problem hiding this comment.
I really like how you provided examples of both Markdown and HTML techniques!
Co-authored-by: Eric Bailey <ericwbailey@users.noreply.github.com>
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.
#25 must be reviewed first! This PR should be rebased after #25 is merged.Fixes: #12
We don't currently have documentation to the rules. This PR introduces a documentation folder, documentation for each rule, and updates the linter error message to link to the rule doc so that consumers have more context to fix the rules.