Skip to content
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

Merged
merged 30 commits into from
Jan 2, 2025

Conversation

jennifer-shehane
Copy link
Member

@jennifer-shehane jennifer-shehane commented Dec 26, 2024

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.

Screenshot 2024-12-26 at 12 25 18 PM

@jennifer-shehane jennifer-shehane self-assigned this Dec 26, 2024
Copy link

cypress bot commented Dec 26, 2024

cypress-documentation    Run #218

Run Properties:  status check passed Passed #218  •  git commit 8eace989a6: lint
Project cypress-documentation
Branch Review top-guides-a11y
Run status status check passed Passed #218
Run duration 03m 41s
Commit git commit 8eace989a6: lint
Committer Jennifer Shehane
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  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  

@jennifer-shehane jennifer-shehane changed the title Add top guides section to a11y intro Add top guides section to a11y intro + a11y content updates Dec 27, 2024
Copy link
Contributor

@marktnoonan marktnoonan left a 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.

docs/accessibility/core-concepts/accessibility-score.mdx Outdated Show resolved Hide resolved
docs/accessibility/core-concepts/accessibility-score.mdx Outdated Show resolved Hide resolved
docs/accessibility/core-concepts/accessibility-score.mdx Outdated Show resolved Hide resolved
docs/accessibility/core-concepts/how-it-works.mdx Outdated Show resolved Hide resolved
docs/accessibility/core-concepts/run-level-reports.mdx Outdated Show resolved Hide resolved

(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
Copy link
Contributor

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.

docs/accessibility/guides/maintain-accessibility.mdx Outdated Show resolved Hide resolved
docs/accessibility/guides/maintain-accessibility.mdx Outdated Show resolved Hide resolved
docs/accessibility/guides/maintain-accessibility.mdx Outdated Show resolved Hide resolved
docs/accessibility/guides/maintain-accessibility.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@marktnoonan marktnoonan left a 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.

@marktnoonan
Copy link
Contributor

Somehow, in the preview environment, styles for highlighted text are different.

Prod:
Screenshot 2025-01-02 at 12 22 22 PM

This PR:
Screenshot 2025-01-02 at 12 22 14 PM

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.

Copy link
Contributor

@marktnoonan marktnoonan left a 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.

@jennifer-shehane
Copy link
Member Author

@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.

@jennifer-shehane jennifer-shehane merged commit 9af85a0 into main Jan 2, 2025
10 checks passed
@jennifer-shehane jennifer-shehane deleted the top-guides-a11y branch January 2, 2025 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants