-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add top guides section to a11y intro + a11y content updates #6059
Conversation
cypress-documentation Run #218
Run Properties:
|
Project |
cypress-documentation
|
Branch Review |
top-guides-a11y
|
Run status |
Passed #218
|
Run duration | 03m 41s |
Commit |
8eace989a6: lint
|
Committer | Jennifer Shehane |
View all properties for this run ↗︎ |
Test results | |
---|---|
Failures |
0
|
Flaky |
0
|
Pending |
0
|
Skipped |
0
|
Passing |
279
|
View all changes introduced in this branch ↗︎ |
UI Coverage
10.85%
|
|
---|---|
Untested elements |
2227
|
Tested elements |
3
|
Accessibility
95.75%
|
|
---|---|
Failed rules |
2 critical
5 serious
4 moderate
0 minor
|
Failed elements |
505
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pointed out a few things here and there. Overall this is a big improvement in readability and scanning, I'm surprised how much actually, the before and after is really a different experience. Marking "request changes" specifically as there is chunk in the "About Axe Core®" section that cuts off unexpectedly.
|
||
(You can skip the `--key` option by setting `CYPRESS_RECORD_KEY` as an environment variable. Learn more about recording in our [Recorded Runs documentation](/cloud/features/recorded-runs)). | ||
|
||
## Key benefits |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since we have removed the mention of other workarounds, the benefits list doesn't really have a reference point. It still makes sense to mention the existence of workarounds that don't require the Cloud I think.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pointed out a few things here and there. Overall this is a big improvement in readability and scanning, I'm surprised how much actually, the before and after is really a different experience. Marking "request changes" specifically as there is chunk in the "About Axe Core®" section that cuts off unexpectedly.
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
…ss-documentation into top-guides-a11y
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
…ss-documentation into top-guides-a11y
Somehow, in the preview environment, styles for highlighted text are different. No idea if this is actually related to some CSS changes in this PR somehow or what it might be, I'd be curious what you see locally. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removing the blocking review - this seems good to merge. I see a few spots where we might come back and tweak the wording in the future, but I'd like it to settle and maybe tackle that in a pass where we add some more images or diagrams.
@marktnoonan I've seen at least one instance where the css attributes are dynamically generated in the preview, but they are stable in prod and we were not targeting the style in a way that would apply to both (so prod was right but preview wasn't). I wonder if that's the case here. |
I rewrote a good bit of the a11y documentation, working on improving conciseness, scannability and adding more visuals. I also added a 'top guides' section to the a11y intro.
Something like below to highlight Top Guides on the main intro page.