gcanti/tcomb-form

Add an examples / recipes section in the doc ?

Open

#178 建立於 2015年8月14日

在 GitHub 查看
 (1 留言) (1 反應) (0 負責人)JavaScript (1,164 star) (141 fork)batch import
Type: Docshelp wanted

描述

Hey,

I was just thinking (yes it happens), looking at the issues raised lately most of them are "how to do X", "how to achieve Y" style of issues, wouldn't be wise to add a section to the doc where we can add examples that answer those questions ? That would help to point others to them.

While I'm at it, you used to have a "playground" section in the doc, any reason this is gone ? Was it too much to maintain or something ?

Again thanks for all the gooood work ^^

貢獻者指南

技術棧
javascriptreact
領域
documentationfrontend
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
tcomb form basicsReactmarkdown
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
65
研究方向
This issue suggests adding an examples/recipes section to the documentation. To proceed, review the repository's documentation structure and identify common 'how to' questions from closed issues. Check git history for the previously removed 'playground' section to understand its content and why it was removed. The maintainer may need to clarify the desired scope and format of examples before implementing.