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

Update crayons components to use Storybook as single source of truth #16334

Open
12 tasks
aitchiss opened this issue Jan 27, 2022 · 6 comments
Open
12 tasks

Update crayons components to use Storybook as single source of truth #16334

aitchiss opened this issue Jan 27, 2022 · 6 comments
Assignees
Labels
area: documentation Issues/PRs related to Forem documentation changes external contributors welcome contribution is welcome!

Comments

@aitchiss
Copy link
Contributor

Our storybook has been getting lots of great updates recently, and as we invest more in it, we want to make sure it's our single source of truth for design-system component documentation. However, a few components still have JSDoc comments either as duplication or instead of comprehensive storybook docs. I'm also including in the list below components that appear in Storybook but don't have docs at all.

For each of these components, we should:

  • Make sure the Storybook docs tab has comprehensive information on the component
  • Make sure relevant prop types are documented in Storybook in the controls tab
  • Once we're satisfied with those two things... delete the JSDoc comments!

I had a quick look, and these are the components I think we need to look at:

  • TagAutocompleteOption
  • LoadingArticle
  • Article
  • CommentSubscription
  • MarkdownToolbar
  • MentionAutocompleteTextArea
  • PodcastEpisode
  • Snackbar
  • ButtonGroup
  • Dropdown
  • Checkbox
  • RadioButton

Some of these have some existing docs or prop controls in Storybook, but most are missing one or the other.

We can address these docs updates in small incremental PRs - one per component

@github-actions
Copy link
Contributor

Thanks for the issue, we will take it into consideration! Our team of engineers is busy working on many types of features, please give us time to get back to you.

Feature requests that require more discussion may be closed. Read more about our feature request process on forem.dev.

To our amazing contributors: issues labeled type: bug are always up for grabs, but for feature requests, please wait until we add a ready for dev before starting to work on it.

To claim an issue to work on, please leave a comment. If you've claimed the issue and need help, please ping @forem/oss. The OSS Community Manager or the engineers on OSS rotation will follow up.

For full info on how to contribute, please check out our contributors guide.

@aitchiss aitchiss mentioned this issue Jan 27, 2022
4 tasks
@aitchiss aitchiss added area: documentation Issues/PRs related to Forem documentation changes external contributors welcome contribution is welcome! labels Jan 27, 2022
@EKivutha
Copy link

EKivutha commented Feb 3, 2022

@aitchiss please assign this issue

@citizen428
Copy link
Contributor

citizen428 commented Feb 3, 2022

@EKivutha I assigned you the issue now, thanks for volunteering.

@aitchiss
Copy link
Contributor Author

aitchiss commented Feb 3, 2022

Thanks for taking on this issue @EKivutha - just a reminder to submit any changes for this as small incremental PRs, ideally component by component. This will help keep things straightforward to review 🙂

@EKivutha
Copy link

EKivutha commented Feb 3, 2022

Noted @aitchiss

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Issues/PRs related to Forem documentation changes external contributors welcome contribution is welcome!
Projects
None yet
Development

No branches or pull requests

4 participants
@citizen428 @aitchiss @EKivutha and others