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

Docs: Update examples for components to look according to guidelines #9679

Merged
merged 1 commit into from Sep 7, 2018

Conversation

Projects
None yet
2 participants
@gziolo
Member

gziolo commented Sep 7, 2018

Description

This PR update examples in README.md documments to follow Contributing guidelines.

See related comment from @mmtr: Automattic/wp-calypso#27022 (comment)

Yep, that's right. Examples are extracted by react-live in order to generate in real time the DevDocs and export is not supported there, so that's why examples shouldn't export anything.

At the moment they are used outside of Gutenberg. However, we want to have a common contract to make it possible to generate docs with examples in other places. Hopefully, in Gutenberg manual, too.

@gziolo gziolo added the Documentation label Sep 7, 2018

@gziolo gziolo added this to the 3.9 milestone Sep 7, 2018

@gziolo gziolo self-assigned this Sep 7, 2018

@gziolo gziolo requested review from nosolosw and vindl Sep 7, 2018

@nosolosw

nosolosw approved these changes Sep 7, 2018 edited

I wasn't aware we use them in devdocs, that's cool!

@gziolo gziolo merged commit ef722fe into master Sep 7, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@gziolo gziolo deleted the update/docs-components branch Sep 7, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment