agrafix/Spock

how to render blaze-html was hard to discover

Open

#142 opened on Apr 17, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Haskell (596 stars) (54 forks)batch import
documentationhelp wanted

Description

Just now on #haskell, a new Spock user and I found it harder than it should be to figure out how to render blaze-html content. I tried: tutorial, docs, haddocks, issues, changelog, blog, hackage search (which found Spock-lucid) and google (which found a blaze helper function in Spock < 0.8). Just FYI. :)

Contributor guide

Tech stack
None
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.
under 1 hour
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue requests clearer documentation on rendering blaze html in Spock. Investigate the current Spock documentation and tutorial for any existing examples or references to blaze html. Consider adding a short code snippet in the README or a dedicated documentation page that shows how to use blaze html with Spock. Look at similar issues or discussions in the repository for context.