Documentation: Add information about `Channel`
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Scala
- Stars
- 2.5k
- Forks
- 636
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 7
Description
@armanbilge Has pointed me in the direction of Channel as the primitive type I may be after.
Channel certainly appears in the API reference, but it might be nice to briefly mention it in the main docs - possibly next to Topic?
Contributor guide
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 locating the main documentation section covering Topic and compare it with Channel in the API reference. Add a brief explanation of Channel near Topic, then check the documentation build or preview to confirm the new information is rendered clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100