The framing strategy should be visible in the generated docs.
貢獻者指南
技術棧
無
領域
backenddocumentation
議題類型
feature
難度面向新貢獻者的預計實作難度,1 表示很小改動,5 表示專家級工作。
4
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度:新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
familiarity with servant frameworkunderstanding of streaming APIsknowledge of servant docs module
新手友善度1-100 的估計分數,表示該議題對首次貢獻者的友善程度。
20
研究方向
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.
Make proper Stream support in servant-docs · haskell-servant/servant#989 | Good First Issue