bengreenier / bengreenier/overlayed2
Bug: Sub-package README's are empty
- Dominant language
- TypeScript
- Stars
- 8
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
**Describe the bug**
The [`packages`](https://github.com/bengreenier/overlayed2/tree/master/packages) should each have their own README explaining that part of the system. Currently, they still have the default lerna README. 😅
**To Reproduce**
Steps to reproduce the behavior:
1. Look at a readme under packages
2. See that it is not helpful nor customized
**Expected behavior**
A wonderful readme explaining what that part of the system is, how to best consume it, and any deviations from the core development flow that would be necessary for a developer to understand when making changes to it.
**Configuration (please complete the following information):**
- Version: [`7a547ff`](https://github.com/bengreenier/overlayed2/commit/7a547ff16bc23c7f6a45597b70c48e18d40a6bb5)
Contributor guide
Research direction
Review the README files under the packages directory and compare them with the package structure and the repository's core development flow. Replace the default Lerna text with package-specific explanations covering each part's purpose, consumption, and any development differences; done means every package README is useful and customized.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- electron, react, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100