WordPress
Some NPM packages do not have a README
The following packages do not have a README.md at npmjs.com, even though they do contain a README.md in their source:
- @wp-playground/blueprints
- @wp-playground/cli
- @wp-playground/client
- @wp-playground/components
- @wp-playground/php-wasm-progress
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 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.
@php-wasm/universal, @php-wasm/fs-journal, and @php-wasm/logger are still missing readmes. I will take another look at it.
The @wp-playground/cli has a new README, I can have a look at other packages.
@wp-playground/client would be really useful, the rest should be fine without a readme. Well, Blueprints could use one, but we're about to merge https://github.com/WordPress/wordpress-playground/pull/2281 so it doesn't make as much sense to write a lot about v1 now.