haskell-servant/servant

Augment tutorial with a section about "real world applications"

Open

#826 opened on Oct 3, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (1,953 stars) (422 forks)batch import
documentationenhancementhelp wanted

Description

It could for example show off several "best practices" or features (custom monad instead of Handler, custom error type instead of ServantErr, redirects, auth, other things?) through a todo-app like example.

cc @phadej @saurabhnanda

Contributor guide

Tech stack
None
Domain
documentationbackend
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.
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
Haskellservantbasic web development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine the existing tutorial documentation in the servant repository. Look at the current tutorial structure and identify where to add a 'real world applications' section. Consider examples like a todo app that showcases custom monads, error types, redirects, and authentication. Review any comments or related issues for guidance.