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

docs: update modal state manager examples #6806

Merged
merged 5 commits into from
Oct 12, 2020

Conversation

emyarod
Copy link
Member

@emyarod emyarod commented Sep 9, 2020

Closes #6591

This PR updates the MDX docs for Modal and ComposedModal to remove references to ModalWrapper which should be deprecated in the future. ModalWrapper is a simple state manager for modals which was not initially meant to be exported and is now replaced by storybook examples under Modal and ComposedModal

Testing / Reviewing

Review the updated modal and composed modal storybook Docs tabs updates

@emyarod emyarod changed the title docs(ModalWrapper): add mdx example docs(ModalWrapper): add storybook MDX example Sep 9, 2020
@emyarod emyarod mentioned this pull request Sep 9, 2020
36 tasks
@netlify
Copy link

netlify bot commented Sep 9, 2020

Deploy preview for carbon-elements ready!

Built with commit b130b2f

https://deploy-preview-6806--carbon-elements.netlify.app

@netlify
Copy link

netlify bot commented Sep 9, 2020

Deploy preview for carbon-components-react ready!

Built with commit b130b2f

https://deploy-preview-6806--carbon-components-react.netlify.app

@joshblack
Copy link
Contributor

@emyarod I think your suggestion to remove it from the exports makes a ton of sense, if you have a sec would appreciate if you added that into the WIP component updates for v11 👀 (Just started consolidating there)

Would it similarly make sense to drop the docs for the component and steer them towards the correct/intended solution?

@emyarod
Copy link
Member Author

emyarod commented Sep 15, 2020

I think it still makes sense to have some documentation around an example (I added one in #6804) but an explicit export like ModalWrapper may no longer be needed in the library

should I use this PR to deprecate ModalWrapper then?

@joshblack
Copy link
Contributor

@emyarod definitely your call, whatever makes the most sense!

@emyarod
Copy link
Member Author

emyarod commented Sep 25, 2020

ok, I think it makes sense to deprecate the component export in the next major version and keep something in storybook for users to reference as an example

@emyarod emyarod marked this pull request as ready for review October 7, 2020 17:34
@emyarod emyarod requested a review from a team as a code owner October 7, 2020 17:34
@emyarod emyarod changed the title docs(ModalWrapper): add storybook MDX example docs: update modal state manager examples and remove ModalWrapper story Oct 7, 2020
@emyarod emyarod changed the title docs: update modal state manager examples and remove ModalWrapper story docs: update modal state manager examples Oct 7, 2020
@joshblack
Copy link
Contributor

bump @aledavila when you get a chance today 👀

@kodiakhq kodiakhq bot merged commit a6205ad into carbon-design-system:master Oct 12, 2020
@emyarod emyarod deleted the 6591-modal-wrapper-docs branch October 13, 2020 14:45
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.

Update docs for Modal
3 participants