JedWatson / JedWatson/react-select
Please improve the "getting started" documentation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 28k
- Forks
- 4.1k
- PR merge metrics
- No merged PRs in 30d
Description
As I wrote a few years ago (now deleted I guess), this documentation is (still) one of the most frustrating I've had with documentation.
The worst part is that it seems so thorough. But getting up and running is VERY time-consuming and frustrating. Even remembering a similar experience of a few years ago when I tried to use it then, I could not remember how to get a basic proof of concept up and running. I do remember being much "softer" with my feedback in my last message, but it's been years and the approach to the documentation has not improved.
I looked for other libraries out there, but for some reason, this is the only real game in town. Please enlist some help with the documentation, someone who actually understands how to teach, and minimize user effort. And most importantly, please consider several listing up-front fully-functional basic examples of controlled components in react style with value setting and change handling. This would save us all a lot of time.
For those wondering the two most important props (value and onChange) to pass ARE NOT EVEN MENTIONED IN THE DOCUMENTATION. And ALSO the value must match the option object (not the value of it).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file or test is named in the issue; begin by locating the existing getting-started documentation and reviewing its current examples. Done should include clear controlled-component examples that explain value, onChange, and the requirement for value to match the option object.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100