Docs for "Getting Started"
See original GitHub issueTrying to use this package I ran into very similar problems as described in #140. Since that’s locked down, I’m hoping I can provide some additional, constructive feedback from a first-time user here (free usability test results!).
The How To Use
section is obviously pretty important, but also pretty confusing. This is the first package with this type of install, so a hint at why this approach is used would help a lot.
From there I was pretty much lost, until I read the comments in the issue linked above. Pointing out examples/SingleDatePickerWrapper.jsx
as port of How to use
(or rename to “Getting Started”) would help a ton. Its already there. Maybe it can even be inlined in the readme, to make it even more obvious.
If those suggestions sound good, I might be able to help with a PR 👋
Issue Analytics
- State:
- Created 7 years ago
- Reactions:3
- Comments:6 (3 by maintainers)
Top GitHub Comments
For the storybook it would be extremely useful to be able to show the code for each story. I think https://github.com/storybooks/react-storybook-addon-info can provide that.
@majapw I’ve put the code together for this (https://github.com/jpollard-cs/react-dates/commit/6061a339a386e7033ac8ee9bdf8d987cfaacbe94), but there’s one issue - since this project uses a non-standard format for prop types, prop type info can’t be provided:
this can be fixed by simply removing the props table by adding
{ propTables: false }
to everyaddWithInfo
call like so:but that would add a lot of clutter/boilerplate to the code (relatively, at least)
there are other ways we could work around this (perhaps by wrapping the info add-on), but wanted to gauge your thoughts on this?