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.

Sign up for GitHub

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

Jump to bottom

undici npm package has no readme #2930

Closed
Uzlopak opened this issue Mar 6, 2024 · 2 comments · Fixed by #2933
Closed

undici npm package has no readme #2930

Uzlopak opened this issue Mar 6, 2024 · 2 comments · Fixed by #2933
Labels
bug Something isn't working

Comments

@Uzlopak
Copy link
Contributor

Uzlopak commented Mar 6, 2024

Visit https://www.npmjs.com/package/undici?activeTab=readme

@Ethan-Arrowood
Symlinking does not work for npm.
@Uzlopak Uzlopak added the bug Something isn't working label Mar 6, 2024
@Ethan-Arrowood
Copy link
Collaborator

Ah silly npm. Looks like this issue is long standing (latest I can find is here: npm/cli#6746)

Recommended fix is to include a prepublish or prepack script that copies the readme

@Uzlopak
Copy link
Contributor Author

Uzlopak commented Mar 6, 2024

or maybe when building docs copy readme md into docs folder?

@mcollina mcollina mentioned this issue Mar 7, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Flip link between docs and README nodejs/undici
2 participants
@Uzlopak @Ethan-Arrowood