Skip to content

Commit

Permalink
Docs: Create docs landing page (#10453)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
platinumazure committed Jun 9, 2018
1 parent fe8bec3 commit d0aae3c
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Documentation

Welcome to our documentation pages! What would you like to view?

## [User Guide](user-guide)

Intended for end users of ESLint. Contains information about core rules, configuration, command line options, formatters, and integrations,
as well as guides for migrating from earlier versions of ESLint.

## [Developer Guide](developer-guide)

Intended for contributors to ESLint and people who wish to extend ESLint. Contains information about contributing to ESLint; creating custom
rules, configurations, plugins, and formatters; and information about our architecture and Node.js API.

## [Maintainer Guide](maintainer-guide)

Intended for maintainers of ESLint.

0 comments on commit d0aae3c

Please sign in to comment.