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 a few guides to UI Coverage #6063

Merged
merged 26 commits into from
Jan 15, 2025
Merged

Add a few guides to UI Coverage #6063

merged 26 commits into from
Jan 15, 2025

Conversation

jennifer-shehane
Copy link
Member

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

Adding guides on common use cases so we can feature them on the intro page.

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

cypress bot commented Dec 30, 2024

cypress-documentation    Run #261

Run Properties:  status check passed Passed #261  •  git commit afcc1206ef: Update docs/ui-coverage/guides/ignore-elements.mdx
Project cypress-documentation
Branch Review uicov-guides
Run status status check passed Passed #261
Run duration 07m 16s
Commit git commit afcc1206ef: Update docs/ui-coverage/guides/ignore-elements.mdx
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 297
View all changes introduced in this branch ↗︎
UI Coverage  10.96%
  Untested elements 2357  
  Tested elements 3  
Accessibility  96.86%
  Failed rules  0 critical   4 serious   4 moderate   0 minor
  Failed elements 438  

Copy link
Contributor

@pstakoun pstakoun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have not completed review yet, will keep going, but a few things so far

docs/ui-coverage/configuration/attributefilters.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/configuration/elementfilters.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/configuration/elementfilters.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/configuration/elementgroups.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/configuration/elementgroups.mdx Outdated Show resolved Hide resolved
@brian-mann
Copy link
Member

@jennifer-shehane it looks like we're being inconsistent with the "paid addon" across the uicov docs...

Currently the "paid addon" is in the "Introduction", and not in the subsequent docs...

...but then we use a totally different "paid addon" banner for pages like:

  • Results API
  • Troubleshooting

Examples

image

image

@jennifer-shehane
Copy link
Member Author

@brian-mann Yes, there is not a consistent design decision on how to show this on pages beyond the Get Started pages.

@jennifer-shehane
Copy link
Member Author

@pstakoun Addressed PR comments in:

docs/ui-coverage/guides/reduce-test-duplication.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/guides/ignore-views-and-links.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/guides/ignore-views-and-links.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/guides/ignore-views-and-links.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/guides/reduce-noise.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/configuration/overview.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/configuration/viewfilters.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/configuration/overview.mdx Show resolved Hide resolved
docs/ui-coverage/guides/reduce-noise.mdx Show resolved Hide resolved
docs/ui-coverage/guides/reduce-noise.mdx Show resolved Hide resolved
@jennifer-shehane
Copy link
Member Author

@pstakoun Some fixes addressed: 133f5f2

Copy link
Contributor

@pstakoun pstakoun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't fully grok the structure of the "Why use X" and then "Common use cases" – there's nothing else under the "Why use X" so do there have to be these double headings?

docs/ui-coverage/configuration/significantattributes.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/configuration/viewfilters.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/configuration/views.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/configuration/viewfilters.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/configuration/views.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/configuration/views.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/configuration/views.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/configuration/views.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/configuration/views.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/configuration/views.mdx Outdated Show resolved Hide resolved
docs/ui-coverage/core-concepts/views.mdx Show resolved Hide resolved
docs/ui-coverage/guides/ignore-elements.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@pstakoun pstakoun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are still inconsistencies, but I think it's good enough to merge and iterate since it's blocking other things.

@jennifer-shehane jennifer-shehane merged commit 215c50b into main Jan 15, 2025
10 checks passed
@jennifer-shehane jennifer-shehane deleted the uicov-guides branch January 15, 2025 18:40
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.

3 participants