Documentation improvement suggestions
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 5.5k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 5
Description
-
The
*syntax for partially applied types is introduced here without referring to the kind-projector plugin. It would be useful to add an explanatory comment in the code or a footnote linking to the plugin documentation. -
Alternative which extends
MonoidKis introduced before the latter. Should the sidebar showSemigroupKandMonoidKbeforeAlternative?
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 with the linked Applicative and Alternative documentation pages, then inspect their sidebar or navigation configuration in the repository. Check how the kind-projector syntax is explained and whether SemigroupK and MonoidK appear before Alternative. Done means the plugin is linked or explained and the sidebar order reflects the requested hierarchy.
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