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: Add links to npm packages in typescript-eslint/packages/* #8987

Open
2 tasks done
JoshuaKGoldberg opened this issue Apr 24, 2024 · 0 comments
Open
2 tasks done
Labels
documentation Documentation ("docs") that needs adding/updating triage Waiting for maintainers to take a look

Comments

@JoshuaKGoldberg
Copy link
Member

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

I just noticed that package docs pages like https://typescript-eslint.io/packages/eslint-plugin never actually link to the npm packages like https://www.npmjs.com/package/@typescript-eslint/eslint-plugin. It'd be a nice convenience for them to add that link.

Maybe, the common kind of npm badge image a lot of projects use, like from shields.io? Note that we should self-host the image (i.e. have a React component) so we don't take a dependency on the external service.

Affected URL(s)

https://typescript-eslint.io/packages/*

@JoshuaKGoldberg JoshuaKGoldberg added triage Waiting for maintainers to take a look documentation Documentation ("docs") that needs adding/updating labels Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation ("docs") that needs adding/updating triage Waiting for maintainers to take a look
Projects
None yet
Development

No branches or pull requests

1 participant