Martmists-GH / Martmists-GH/compose-node-editor
Add KDoc
Open
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 29
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
- [ ] Add documentation to public Compose API
- [ ] Add documentation to data types
- [ ] Add Dokka plugin
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the public Compose API, data types, and the project build configuration. Add KDoc to the identified public declarations and configure the Dokka plugin; done means the requested API and type documentation is present and Dokka is set up successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kotlin
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100