Docs: Create docs landing page #10453
Merged
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
The main purpose of this landing page is to allow users to view "https://eslint.org/docs", which currently is HTTP 404 on our site. As a secondary benefit, this would also allow the landing page to be used as the launching point for Algolia's Docsearch crawler.
platinumazure
added
documentation
kaicataldo
approved these changes
Jun 7, 2018
aladdin-add
reviewed
Jun 8, 2018
| @@ -0,0 +1,17 @@ | |||
| # Documentation | |||
|
|
|||
| Welcome to our documentation pages! What would you like to view? | |||
There was a problem hiding this comment.
what about adding a short description about ESLint on the top?
There was a problem hiding this comment.
@aladdin-add Thanks for the suggestion! I feel that would be slightly redundant given the homepage and About pages. If you feel strongly, you or I could always add that in another PR. I'm going to go ahead and merge as is since this is easy to correct and won't impact users of ESLint (the library).
platinumazure
added
accepted
eslint-deprecated
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The main purpose of this landing page is to allow users to view "https://eslint.org/docs", which currently is HTTP 404 on our site.
As a secondary benefit, this would also allow the landing page to be used as the launching point for Algolia's Docsearch crawler.
What is the purpose of this pull request? (put an "X" next to item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Created a docs landing page, which links to the user guide, developer guide, and maintainer guide.
Is there anything you'd like reviewers to focus on?
Any improvements for the text I've written in each section?