core icon indicating copy to clipboard operation
core copied to clipboard

Ensure each package's README lists purpose and accurate usage examples

Open mcmire opened this issue 10 months ago • 1 comments

Most of the packages in the core repo have a very spartan README. While this makes it easy to maintain, it is not very helpful for contributors.

Ideally, each package's README should describe its purpose and provide usage examples.

As a bonus, we should consider finding a way to make the usage examples executable, and run them in CI (similar to Rust's documentation tests).

mcmire avatar May 01 '25 04:05 mcmire

Hi @mcmire , I’ve opened a PR for this. I’d really appreciate it if you could take a look when you get a chance. Thanks.

lukasbauer54 avatar May 21 '25 09:05 lukasbauer54