WordPress / wordpress-playground

Run WordPress in the browser via WebAssembly PHP
https://w.org/playground/
GNU General Public License v2.0
1.65k stars 261 forks source link

Some NPM packages do not have a README #1925

Open psrpinto opened 1 month ago

psrpinto commented 1 month ago

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.

bgrgicak commented 1 month ago

@psrpinto in https://github.com/WordPress/wordpress-playground/pull/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.

adamziel commented 1 week ago

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 commented 1 week ago

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.

adamziel commented 1 week ago

Thank you Paulo!