Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
GitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
Docs: add TOC to user-guide/configuring.md #13727
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
What changes did you make? (Give an overview)
Added a very basic Table of Contents to https://eslint.org/docs/user-guide/configuring / https://github.com/eslint/eslint/blob/master/docs/user-guide/configuring.md
Is there anything you'd like reviewers to focus on?
https://github.com/metasean/eslint/blob/toc-for-contributing.md/docs/user-guide/configuring.md#configuring-eslint (scroll past the introductory text to see the TOC)
Hi @metasean, thanks for the PR and sorry for the late response!
I think this would be a very useful addition. but we are currently reorganizing this document and that work will be done soon (#13632), so I'm not sure should we be making changes to this particular document in the meantime.
@kaicataldo what do you think about this?
@mdjermanovic - All I know is that I really hate having to search through this long page when I have a basic idea of what I'm looking for. (And I'm assuming I'm not the only one with this problem.)
So, as long as there's a better way to navigate all this information I'll be happy, regardless of whether that better way is based on this PR or on a re-organization of the documentation itself.
@metasean this is really helpful. Thank you! We are currently working on the configuration documentation, both to reorganize the documentation and to improve its presentation. This TOC will def be helpful in the process.
@kaicataldo Thank you for pointing this out. Will keep this in mind as we move forward with the project.