gcanti/tcomb-form

Add an examples / recipes section in the doc ?

Open

#178 opened on Aug 14, 2015

View on GitHub
 (1 comment) (1 reaction) (0 assignees)JavaScript (1,164 stars) (141 forks)batch import
Type: Docshelp wanted

Description

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 ^^

Contributor guide

Tech stack
javascriptreact
Domain
documentationfrontend
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
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
tcomb form basicsReactmarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
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.