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

Addon-docs: Basic skeleton, UI viewMode handling #7107

Merged
merged 4 commits into from Jun 18, 2019
Merged

Conversation

shilman
Copy link
Member

@shilman shilman commented Jun 17, 2019

Issue: #7101

What I did

This is a skeleton for addon-docs. It introduces a new viewMode called docs that renders a react component, params.docs in the preview iframe. In subsequent PRs that component will get filled in with either the DocsPage ("auto-generated docs") or MDX loaded from a file.

This PR builds on #6382, so it should be reviewed after that PR is merged into next. Just queueing up the work here.

How to test

yarn test
cd examples/official-storybook
yarn storybook 
# view docs tab for Addons|Docs story => "hello docs"
# view docs tab for everything else => "No docs found"

@vercel
Copy link

vercel bot commented Jun 17, 2019

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

Latest deployment for this branch: https://monorepo-git-tech-docs-view-mode.storybook.now.sh

@shilman shilman changed the title Docs view mode Addon-docs: Basic skeleton, UI viewMode handling Jun 17, 2019
@shilman shilman added this to the 5.2.0 milestone Jun 17, 2019
Copy link
Member

@tmeasday tmeasday left a comment

Choose a reason for hiding this comment

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

LGTM apart from one small mistake

lib/core/src/client/preview/start.js Outdated Show resolved Hide resolved
@shilman shilman merged commit da7b6bd into next Jun 18, 2019
@shilman shilman deleted the tech/docs-view-mode branch June 18, 2019 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants