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

Add an index table to the README.md #11

Open
JoshuaKGoldberg opened this issue Jul 18, 2024 · 0 comments
Open

Add an index table to the README.md #11

JoshuaKGoldberg opened this issue Jul 18, 2024 · 0 comments
Labels
area: documentation Improvements or additions to documentation ("docs") team assigned

Comments

@JoshuaKGoldberg
Copy link
Member

The README.md is really really sparse right now:

typescript-eslint Examples

Various examples of working with typescript-eslint. 📝
We may add to this over time, or we may get rid of it in favor of typescript-eslint.io.
We'll see.

Folks have to click into packages/ to see them, and even then each needs its own README.md read to learn more than just what's in the title. Let's add a nice summary table explaining what each is!

@JoshuaKGoldberg JoshuaKGoldberg added team assigned area: documentation Improvements or additions to documentation ("docs") labels Jul 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Improvements or additions to documentation ("docs") team assigned
Projects
None yet
Development

No branches or pull requests

1 participant