[docs] Expand landing page #17634
Merged
[docs] Expand landing page #17634
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
sideshowbarker
approved these changes
Jul 4, 2019
sideshowbarker
approved these changes
Jul 4, 2019
docs/index.md
Outdated
| @@ -0,0 +1,62 @@ | |||
| # web-platform-tests documentation | |||
|
|
|||
| The web-platform-tests Project is a W3C-coordinated attempt to build a | |||
There was a problem hiding this comment.
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
Outdated
| 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 |
There was a problem hiding this comment.
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)
|
Thanks, @sideshowbarker! It's been a week, so I'm going to merge this, now |
This was referenced Jul 12, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.