milessabin/shapeless

add microsite?

Open

#875 opened on Jan 24, 2019

View on GitHub
 (1 comment) (9 reactions) (0 assignees)Scala (520 forks)batch import
DocumentationHelp wantedgood first issue

Repository metrics

Stars
 (3,399 stars)
PR merge metrics
 (Avg merge 21h 34m) (6 merged PRs in 30d)

Description

Most awesome FP libraries (Cats, Scalaz, Monocle, Algebird etc ) have microsite done by sbt-microsites

Adding one for Shapeless would make it easier for newcomers. Quick, online reference on what is available would be useful for everyone.

Contributor guide

Research direction
Explore the sbt microsites plugin by looking at examples from Cats, Scalaz, etc. Set up the microsite configuration in the Shapeless project and create documentation pages covering key features.
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.
2
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
GitScalasbt
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80