Addon-docs: Packaging for 5.2 release #7741
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This pull request is automatically deployed with Now. |
shilman
changed the title
ndelangen
approved these changes
Aug 12, 2019
domyen
requested changes
Aug 12, 2019
addons/docs/docs/docspage.md
Outdated
|
|
||
| `DocsPage` pulls info from many sources, but one of the main ones is the `component` parameter, which is a new addition to Storybook in 5.2. It's based on the idea that each component should have an associated set of documentation and stories (versus organizing it in some other way). | ||
|
|
||
| Storybook uses `component` to extract the component's description and props, and in future versions will probably do more with it. We encourage you to add it to existing stories and use it in all new stories. |
There was a problem hiding this comment.
Suggested change
| Storybook uses `component` to extract the component's description and props, and in future versions will probably do more with it. We encourage you to add it to existing stories and use it in all new stories. | |
| Storybook uses `component` to extract the component's description and props, and will rely on it further in future releases. We encourage you to add it to existing stories and use it in all new stories. |
This was referenced Aug 13, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue: #7480 #7456
Also: #7430
What I did
These docs in the
addon-docspackage are intended to replace the Technical Preview Google Doc in preparation for the 5.2 final release.configureJsxpreset optionDocsPageslots API (breaking change)Storybook Docs,DocsPage, andMDXWhat I need
Please review and test out the installation instructions in your project.
One thousand thank you's!! 🙏 🙏 🙏
How to test