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.

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

Fix/readme #45

Merged
merged 5 commits into from
Jan 29, 2019
Merged

Fix/readme #45

merged 5 commits into from
Jan 29, 2019

Conversation

samuel-gomez-axa
Copy link
Contributor

Related issue

No issue, the README of components dont display on addon storybook-readme

Description of the fix

  • Fix the addon addStories
  • Update all stories
  • Update Title composant
  • Update some Readme (Tabs, Table, Title ...)
  • Fix displayName of dotted name component (Table, Tabs) for better story source on Storybook
  • Update Storybook to 4.1.9

Person(s) for reviewing proposed changes

@guillaumechervetaxa

@@ -136,7 +136,8 @@ stories.push({

const storyData = {
name: 'Form.Input.Checkbox',
docs:readme,
docs: readme,
Copy link
Contributor

Choose a reason for hiding this comment

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

Why insert readme inside "readme" and "docs"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In many components, the readme was included in the docs part.
I did not know if I had to keep together.
So, I insert the readme in both.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do you want to remove all readme in docs ?
Or do you want to remove the docs completly ?

Copy link
Contributor

Choose a reason for hiding this comment

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

What do you prefer?
I don't like the tabs readme because people don't think to click on it. I prefer to display the readme directly on the main page ^^ (no user effort to do)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok i delete readme tab, just keep the docs below the demo.

@samuel-gomez-axa samuel-gomez-axa merged commit 7c5f4e7 into master Jan 29, 2019
@delete-merged-branch delete-merged-branch bot deleted the fix/readme branch January 29, 2019 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants