question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Docs for "Getting Started"

See original GitHub issue

Trying 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:open
  • Created 7 years ago
  • Reactions:3
  • Comments:6 (3 by maintainers)

github_iconTop GitHub Comments

7reactions
jzaefferercommented, Nov 8, 2016

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.

0reactions
jpollard-cscommented, Nov 22, 2016

@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 every addWithInfo call like so:

storiesOf('DateRangePicker', module)
  .addWithInfo('default', () => (
    <DateRangePickerWrapper />
  ), { propTables: false })

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?

Read more comments on GitHub >

github_iconTop Results From Across the Web

Google Docs: Getting Started with Your Document - GCF Global
Open Google Docs, and create a new blank file. Change the document title from Untitled Document to Practice Document. Change the page orientation...
Read more >
Google Docs training and help
Get started with Docs. What you'll learn: Create or import; Edit and format; Share and collaborate; Print and download; Access your calendar, notes, ......
Read more >
Getting started with GitHub
Learn how to start building, shipping, and maintaining software with GitHub. Explore our products, sign up for an account, and connect with the...
Read more >
Get started with Google Cloud | Documentation
Prepare and register for certifications. ... Browse upcoming Google Cloud events. ... Read our latest product news and stories. ... Explore case studies...
Read more >
Getting Started with Google Docs - Welcome
Create a Google Account · Create a New Document · Save a New Document · Rename a New Document · Upload an Existing...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found