milessabin/shapeless

add microsite?

Open

#875 opened on Jan 24, 2019

View on GitHub
 (1 comment) (9 reactions) (0 assignees)Scala (3,405 stars) (522 forks)batch import
DocumentationHelp wantedgood first issue

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

Tech stack
None
Domain
documentation
Issue type
feature
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Scalasbtsbt microsites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue proposes adding a microsite for Shapeless using sbt microsites, similar to other FP libraries like Cats and Scalaz. The task involves setting up sbt microsites, configuring it for the Shapeless project, and deploying the site. Look at the existing Scala documentation structure and the sbt microsites documentation for integration. No maintainer response is needed as the issue is open and the request is clear.