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] Expand landing page #17634

Merged
merged 2 commits into from Jul 11, 2019

Conversation

@jugglinmike
Copy link
Contributor

jugglinmike commented Jul 3, 2019

Currently, the documentation website's landing page contains only a
table of contents. The introductory material is accessible through the
first link in that index.

Because the landing page is itself an introduction, it ought to offer
some explanation of the project's purpose and structure.

Re-use the introductory text found in the project's README.md file since
this is slightly more complete than the corresponding text in the
"introduction" page. Move other high-level information to the landing
page and rename the "introduction" to "testsuite design" in order to
better describe its more narrow focus.


This pushes the full table of content below the fold, but I think that's a fair
trade off considering that we'll still have an abbreviated version in the
navigation menu.

Currently, the documentation website's landing page contains only a
table of contents. The introductory material is accessible through the
first link in that index.

Because the landing page is itself an introduction, it ought to offer
some explanation of the project's purpose and structure.

Re-use the introductory text found in the project's README.md file since
this is slightly more complete than the corresponding text in the
"introduction" page. Move other high-level information to the landing
page and rename the "introduction" to "testsuite design" in order to
better describe its more narrow focus.
Copy link
Member

sideshowbarker left a comment

I found a few copy edits that could be made to some of the existing text being moved

@@ -0,0 +1,62 @@
# web-platform-tests documentation

The web-platform-tests Project is a W3C-coordinated attempt to build a

This comment has been minimized.

Copy link
@sideshowbarker

sideshowbarker Jul 4, 2019

Member
Suggested change
The web-platform-tests Project is a W3C-coordinated attempt to build a
The web-platform-tests project is a W3C-coordinated attempt to build a
docs/index.md Show resolved Hide resolved
cross-browser testsuite for [the Web-platform
stack](https://platform.html5.org). Writing tests in a way that allows them to
be run in all browsers gives browser projects confidence that they are shipping
software that is compatible with other implementations, and that later

This comment has been minimized.

Copy link
@sideshowbarker

sideshowbarker Jul 4, 2019

Member
Suggested change
software that is compatible with other implementations, and that later
software which is compatible with other implementations, and that later

(very minor nit; …just to avoiding repeating the word that)

@jugglinmike

This comment has been minimized.

Copy link
Contributor Author

jugglinmike commented Jul 11, 2019

Thanks, @sideshowbarker! It's been a week, so I'm going to merge this, now

@jugglinmike jugglinmike merged commit 6d60c3d into web-platform-tests:master Jul 11, 2019
9 checks passed
9 checks passed
Azure Pipelines Build #20190704.273 succeeded
Details
Azure Pipelines (./wpt test-jobs) ./wpt test-jobs succeeded
Details
Azure Pipelines (affected tests without changes: Safari Technology Preview) affected tests without changes: Safari Technology Preview succeeded
Details
Azure Pipelines (affected tests: Safari Technology Preview) affected tests: Safari Technology Preview succeeded
Details
Azure Pipelines (wpt.fyi hook: safari-preview-affected-tests) wpt.fyi hook: safari-preview-affected-tests succeeded
Details
Azure Pipelines (wpt.fyi hook: safari-preview-affected-tests-without-changes) wpt.fyi hook: safari-preview-affected-tests-without-changes succeeded
Details
Taskcluster (pull_request) TaskGroup: success
Details
staging.wpt.fyi - safari[experimental] Safari results
Details
wpt.fyi - safari[experimental] Safari results
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.