cypress-documentation
cypress-documentation copied to clipboard
Documentation examples should follow best practices
In particular, selecting arguments by ID/class is explicitly recommended to be used only "sparingly", yet many examples, including the best practices use those.
Docs should follow best practices and always use contains or get("[data-attr-cy='...']") where appropriate.
- Using IDs or classes in the examples should be updated for consistency with
data-*, per the best practices docs. API pages need to be addressed. - There is a larger conversation kicking off to revise the best practice docs around selectors to consider things like
cy.contains()in examples, accessibility (using aria roles,labels,etc) and RTL style selectors.
This seems to have been addressed