Open psrpinto opened 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.
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.
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.
Thank you Paulo!
The following packages do not have a
README.md
at npmjs.com, even though they do contain aREADME.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 runningnpx nx build playground-client
, one can see theREADME.md
initially being placed underdist/
, and then being removed once the vite build completes.