docs(Combobox): update dev docs; add mdx docs #6734
Conversation
|
Deploy preview for carbon-elements ready! Built with commit aae5638 |
|
Deploy preview for carbon-components-react ready! Built with commit aae5638 https://deploy-preview-6734--carbon-components-react.netlify.app |
|
Deploy preview for carbon-elements ready! Built with commit 877aeff |
|
Deploy preview for carbon-components-react ready! Built without sensitive environment variables with commit 877aeff https://deploy-preview-6734--carbon-components-react.netlify.app |
| - [Component API](#component-api) | ||
| - [Feedback](#feedback) | ||
|
|
||
| ## Overview |
There was a problem hiding this comment.
Might be able to use the same strategy as TJ did over in Dropdown for use-cases / component API: https://github.com/carbon-design-system/carbon/blob/master/packages/react/src/components/Dropdown/Dropdown.mdx
Some other examples could be:
- Skeleton
- Controlled vs uncontrolled
- Invalid states
- Label guidance (how to label it so that it's accessible)
|
bump @dakahn let me know when a good time to re-review is for this! 👀 |
|
@joshblack I added some more detail on some pitfall props (a couple you mentioned). Didn't see a skeleton for this component though, but I could just be being daft |
|
Do we think it would be helpful to add guidance on how to use some of the other more complex props like If we don't want to duplicate documentation for props like |
|
I'm not sure how to distinguish which props are complex to use? It could be that I'm just used to looking at these things but when it comes to docs like this It just doesn't seem to provide that much additive value. If we're just going to write a quick sentence and show and example of every prop being used in context then that's cool, but there doesn't seem to be anything particularly complex about that prop, no? |
|
I think it's more of along the lines (for me) that it doesn't take much effort to add in that extra value for someone that may need it but will exponentially reduce any question we get asked about that prop in the future. We seem to get a lot of questions from newer React developers, so I don't think it hurts to be too explicit. I would just like to err on the side of "too much documentation" rather than having to go back and add more in later, which inevitably won't happen. |
|
I'm fine either way 👍 |
|
bump @dakahn do you have a preference? |
|
I'll throw a few more examples in like what i see in TJ's pr and we can call it good |
| For more information, checkout the Downshift prop | ||
| [documentation](https://www.downshift-js.com/downshift#props-used-in-examples) | ||
|
|
||
| ## Placeholders and Labeling |
There was a problem hiding this comment.
| ## Placeholders and Labeling | |
| ## Placeholders and labeling |
| ## Table of Contents | ||
|
|
||
| <!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
|
|
||
| - [Overview](#overview) |
There was a problem hiding this comment.
Would it help to add the new sections to the TOC too or nah?
|
bump @tw15egan if you have a sec today/next week |
|
oh yeah lemme do that right quick @joshblack |
|
Can we just bump the prop table a bit further up the page? The rest looks good to me 👍 |
tw15egan
force-pushed
the
update-combobox-devdocs
branch
from
e5aeb3d to
92192f0
Compare
Closes #6629
Updates the dev docs using our new template. Adds MDX file and relevant stories.
Getting it up here so we can start hashing out what this should look like
Testing/reviewing
Make sure all functionality we want to demonstrate is accounted for and working correctly 👍