Ensure each core package's README lists purpose and accurate usage examples
- Dominant language
- TypeScript
- Stars
- 413
- Forks
- 308
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 253
Description
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](https://doc.rust-lang.org/rustdoc/documentation-tests.html)).
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by surveying the package READMEs in the core repository and identify which packages lack a clear purpose or accurate usage examples. Update the relevant READMEs, then verify that each describes its purpose and shows usable examples; the optional executable-example and CI work is a separate, broader follow-up.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100