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(readme): add table of contents #86

Merged
merged 1 commit into from Feb 7, 2018

Conversation

macklinu
Copy link
Contributor

@macklinu macklinu commented Feb 7, 2018

This PR aims to clean up the README a little bit and add a table of contents. I see this as a first step to resolving #61.

I generated the table of contents by running npx doctoc README.md --notitle --maxlevel=3. I wanted to set up lint-staged in this PR, but I had trouble installing it using Node 4 and npm 2 in my local development environment. (I'll open an issue to discuss using Node 8 and npm 5 as the preferred development environment, but continue running tests on Node 4 to continue supporting that version of Node with this ESLint plugin.)

The primary change is that all rules are documented below the Rules section with the following convention:

### `rule-name`

This allows for consistent documentation URLs, which now look like https://github.com/xjamundx/eslint-plugin-promise#rule-name.

Once this is merged, I will open a follow up PR to add the meta.docs.url field to all rules, which should close #61. (ESLint did a similar thing in their codebase in eslint/eslint#9788)

@macklinu macklinu mentioned this pull request Feb 7, 2018
@macklinu macklinu merged commit d52d30c into eslint-community:master Feb 7, 2018
@macklinu macklinu deleted the readme-toc branch February 7, 2018 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Broken rule documentation links
1 participant