gcanti/tcomb-form

Add an examples / recipes section in the doc ?

Open

#178 opened on 2015年8月14日

GitHub で見る
 (1 comment) (1 reaction) (0 assignees)JavaScript (1,164 stars) (141 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.
Add an examples / recipes section in the doc ? · gcanti/tcomb-form#178 | Good First Issue