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

[docs] Restructure explanations of test types #16360

Merged
merged 2 commits into from Apr 30, 2019

Conversation

jugglinmike
Copy link
Contributor

The project documentation includes two lists of WPT's various test
types. Update these lists in the interest of helping readers orient
themselves to the project.

  • Present reftests and visual tests under a generic "rendering test"
    item in recognition of the related nature of those two test types. Use
    the new item in the "Writing Tests" document to recommend the
    rendering test guidelines.
  • Consistently introduce WebDriver tests in both lists

This is an attempt to resolve bocoup/wpt-docs#5. It's a little less ambitious than the plan outlined there because it only changes the structure of the table of contents--not the documents themselves. This doesn't reduce the number of concepts we present, but I'm hoping it still helps readers build an understanding.

The project documentation includes two lists of WPT's various test
types. Update these lists in the interest of helping readers orient
themselves to the project.

- Present reftests and visual tests under a generic "rendering test"
  item in recognition of the related nature of those two test types. Use
  the new item in the "Writing Tests" document to recommend the
  rendering test guidelines.
- Consistently introduce WebDriver tests in both lists
Copy link
Member

@gsnedders gsnedders left a comment

Choose a reason for hiding this comment

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

The duplication here is somewhat annoying :(

docs/_writing-tests/index.md Show resolved Hide resolved
docs/_writing-tests/index.md Show resolved Hide resolved
docs/_writing-tests/index.md Outdated Show resolved Hide resolved
@gsnedders gsnedders merged commit 77076ee into web-platform-tests:master Apr 30, 2019
marcoscaceres pushed a commit that referenced this pull request Jul 23, 2019
The project documentation includes two lists of WPT's various test
types. Update these lists in the interest of helping readers orient
themselves to the project.

- Present reftests and visual tests under a generic "rendering test"
  item in recognition of the related nature of those two test types. Use
  the new item in the "Writing Tests" document to recommend the
  rendering test guidelines.
- Consistently introduce WebDriver tests in both lists
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Downplay relevance of visual tests
5 participants