typelevel/cats-effect

Smarter version numbers in the docs

Open

#523 opened on May 1, 2019

View on GitHub
 (23 comments) (1 reaction) (0 assignees)Scala (572 forks)batch import
:books: docsgood first issue

Repository metrics

Stars
 (2,230 stars)
PR merge metrics
 (Avg merge 21d 23h) (18 merged PRs in 30d)

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.

  1. Consider making a more anemic README that drives straight to the site.
  2. Derive the version number in the site when publishing.

Failure to do so was responsible for #252.

Relevant Gitter conversation

Contributor guide

Research direction
Investigate automating version number updates in documentation using sbt microsite and consider reducing README duplication.
Tech stack
scala
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Scalasbt
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60