luckyframework / luckyframework/carbon
Add inline docs
Open
- Dominant language
- Crystal
- Stars
- 87
- Forks
- 20
- PR merge metrics
- No merged PRs in 30d
Description
Now that we publish API docs, we need to start filling in all of the actual inline documentation. Once that's done, the docs in the README can point to the official API docs.
Contributor guide
No contributing guide indexed for this repository
Research direction
Review the Crystal library's public API and the existing README documentation first. Add inline documentation throughout the API, then update the README so it can point readers to the official API docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- crystal
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100