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

Some NPM packages do not have a README #1925

Open
psrpinto opened this issue Oct 19, 2024 · 6 comments · Fixed by #2156
Open

Some NPM packages do not have a README #1925

psrpinto opened this issue Oct 19, 2024 · 6 comments · Fixed by #2156
Assignees
@bgrgicak
Labels
[Focus] Developer Tools [Type] Bug An existing feature does not function as intended [Type] Developer Experience

Comments

@psrpinto
Copy link
Member

The following packages do not have a README.md at npmjs.com, even though they do contain a README.md in their source:

The README is missing from the packages because the vite build removes it, I believe.

Using @wp-playground/client as an example, when running npx nx build playground-client, one can see the README.md initially being placed under dist/, and then being removed once the vite build completes.
@psrpinto psrpinto added the [Type] Bug An existing feature does not function as intended label Oct 19, 2024
@bgrgicak
Copy link
Collaborator

@psrpinto in #1924 you touched on something important.

We need to figure out where to store developer content relevant to the source code and how to separate it from the NPM package description.

@bgrgicak bgrgicak moved this from Inbox to Needs Triage/Our Reply in Playground Board Oct 23, 2024
@psrpinto psrpinto mentioned this issue Oct 23, 2024
Merged
@adamziel
Copy link
Collaborator

Including the developer README.md directly with these packages would be better than nothing for now. I'd still love to have dedicated README files for npm but yeah, that will take more time and effort.

@psrpinto
Copy link
Member Author

psrpinto commented Nov 15, 2024 •
edited
Loading

Makes sense, I'll assign this to myself and fix the issue of vite removing the READMEs. That will result in the existing READMEs being published with the packages.

@psrpinto psrpinto self-assigned this Nov 15, 2024
@adamziel
Copy link
Collaborator

Thank you Paulo!

@adamziel adamziel moved this from Needs Triage/Our Reply to Bugs Backlog in Playground Board Dec 18, 2024
@bgrgicak bgrgicak linked a pull request Feb 26, 2025 that will close this issue
Ensure all NPM packages have readmes included in their builds #2156
Merged
@bgrgicak bgrgicak assigned bgrgicak and unassigned psrpinto Feb 26, 2025
@github-project-automation github-project-automation bot moved this from Backlog to Done in Playground Board Feb 27, 2025
@adamziel adamziel reopened this Feb 27, 2025
@github-project-automation github-project-automation bot moved this from Done to Inbox in Playground Board Feb 27, 2025
@adamziel
Copy link
Collaborator

I’ll reopen this until the readme shows up on npm

@bgrgicak bgrgicak moved this from Inbox to In progress in Playground Board Feb 27, 2025
@bgrgicak
Copy link
Collaborator

@php-wasm/universal, @php-wasm/fs-journal, and @php-wasm/logger are still missing readmes. I will take another look at it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bgrgicak bgrgicak

Labels
[Focus] Developer Tools [Type] Bug An existing feature does not function as intended [Type] Developer Experience
Projects
Playground Board
Status: In progress
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Ensure all NPM packages have readmes included in their builds WordPress/wordpress-playground
3 participants
@adamziel @psrpinto @bgrgicak