Type Docs
- Dominant language
- TypeScript
- Stars
- 55
- Forks
- 10
- PR merge metrics
- No merged PRs in 30d
Description
**Is your feature request related to a problem? Please describe.**
> Most types in Kaioken are undocumented IN CODE, meaning, when i hover over pretty much anything, i get no description or details about what that thing is. I do get a type signature but often times those are unreadable
**Describe the solution you'd like**
> I would like to see the codebase progressively get documented in code
**Describe alternatives you've considered**
> N/A
**Additional context**
> Ofcourse i know what a useEffect is, but heres a small example:
Contributor guide
Research direction
The issue does not name any files, types, entry points, or tests, so start by surveying the TypeScript codebase to identify undocumented public types and determine the project’s documentation conventions. Define a focused scope and a way to verify that the selected types provide useful hover descriptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100