haskell-servant/servant

Make proper Stream support in servant-docs

Open

#989 opened on Jun 23, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (422 forks)batch import
enhancementhelp wantedservant-docs

Repository metrics

Stars
 (1,953 stars)
PR merge metrics
 (Avg merge 5h 49m) (2 merged PRs in 30d)

Description

The framing strategy should be visible in the generated docs.

Contributor guide

Research direction
Examine the servant docs source to understand how endpoints are documented. Identify where stream framing is handled and add it to the doc generation.
Tech stack
None
Domain
backendapidocumentation
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-3 hours
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
Haskellservant
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30