The framing strategy should be visible in the generated docs.
Contributor guide
Tech stack
None
Domain
backenddocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
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.
mostly clear
Prerequisites
familiarity with servant frameworkunderstanding of streaming APIsknowledge of servant docs module
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Investigate the servant docs module to understand how documentation is generated for endpoints. Look at how streaming endpoints are defined in servant and how they are currently documented. Propose a solution to include framing strategy in the generated docs. Check if there are any comments or related issues for guidance.