typelevel / typelevel/cats-effect
Smarter version numbers in the docs
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
When we release, we have to change the version number twice in the README and once in the tut. The README is currently included directly in the site. sbt-microsite has some automation for the latter, but can't help with the former.
- Consider making a more anemic README that drives straight to the site.
- Derive the version number in the site when publishing.
Failure to do so was responsible for #252.
Relevant Gitter conversation
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 reviewing the version references in the README and tut, then inspect the sbt-microsite automation and the linked Gitter conversation. Compare the proposed README and publishing approaches, using #252 as the failure case. Done means a release updates the site and documentation without repeated manual version edits.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation, release
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100