Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update readme for clarity #9731

Closed
wants to merge 1 commit into from
Closed

update readme for clarity #9731

wants to merge 1 commit into from

Conversation

dvnrsn
Copy link

@dvnrsn dvnrsn commented Feb 3, 2020

Issue: As documented in this issue the docs fail to mention prereq docgen for addon-docs

What I did

Include language in README to guide developer in the right direction

How to test

  • Is this testable with Jest or Chromatic screenshots?
  • Does this need a new example in the kitchen sink apps?
  • Does this need an update to the documentation?

If your answer is yes to any of these, please make sure to include it in your PR.

shilman
shilman requested changes Feb 3, 2020
View reviewed changes
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @dvnrsn!!! Please see my clarification below 😄

addons/docs/README.md
yarn add -D babel-plugin-react-docgen
```

and add `react-docgen` to babelrc.
Copy link
Member

@shilman shilman Feb 3, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only if you have a custom babelrc? I believe Storybook's default already includes this, but please let me know if this lines up with what you've seen.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is beyond my understanding. When I remove my .babelrc, I get syntax errors around my JSX in storybook. I would have assumed without my babelrc storybook would have used a custom config, but would that custom config automatically have preset-react? How can I find that custom config?

I simply followed the config here which I thought will always be necessary with addon-docs?

@shilman shilman added addon: docs documentation patch:yes Bugfix & documentation PR that need to be picked to main branch labels Feb 3, 2020
@ndelangen ndelangen changed the title udpate readme for clarity update readme for clarity Feb 14, 2020
@stale
Copy link

stale bot commented Mar 6, 2020

Hi everyone! Seems like there hasn't been much going on in this issue lately. If there are still questions, comments, or bugs, please feel free to continue the discussion. Unfortunately, we don't have time to get to every issue. We are always open to contributions so please send us a pull request if you would like to help. Inactive issues will be closed after 30 days. Thanks!

@stale stale bot added the inactive label Mar 6, 2020
@stale stale bot removed the inactive label Mar 7, 2020
@ndelangen
Copy link
Member

@shilman what do you want to do with this?

@ndelangen ndelangen requested a review from shilman April 16, 2020 11:13
@ndelangen
Copy link
Member

This information is no longer correct as of 6.0.0 I think.

@shilman please re-open if you think this PR should still move forwards.

@ndelangen ndelangen closed this Aug 19, 2020
@dependencies dependencies bot mentioned this pull request Jan 15, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shilman shilman Awaiting requested review from shilman

Assignees

@shilman shilman

Labels
addon: docs documentation patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dvnrsn @ndelangen @shilman