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(primitives): add storybook documentation #2094

Merged
merged 2 commits into from
Mar 20, 2024

Conversation

sungik-choi
Copy link
Contributor

@sungik-choi sungik-choi commented Mar 19, 2024

Self Checklist

  • I wrote a PR title in English and added an appropriate label to the PR.
  • I wrote the commit message in English and to follow the Conventional Commits specification.
  • I added the changeset about the changes that needed to be released. (or didn't have to)
  • I wrote or updated documentation related to the changes. (or didn't have to)
  • I wrote or updated tests related to the changes. (or didn't have to)
  • I tested the changes in various browsers. (or didn't have to)
    • Windows: Chrome, Edge, (Optional) Firefox
    • macOS: Chrome, Edge, Safari, (Optional) Firefox

Summary

Dialog/TooltipPrimitive의 스토리북 문서를 추가합니다.

Details

  • 스토리북에 primitive 컴포넌트를 추가해서 다른 팀원들이 컴포넌트의 존재를 알 수 있도록 했습니다.
  • 컴포넌트명이 radix-ui와 완벽하게 동일하지는 않기 때문에, 사용자의 이해를 돕고자 mdx를 사용, Anatomy 항목을 추가했습니다.
  • 스토리북 전체: stories.mdx -> .mdx 로 일괄 변경했습니다.

Breaking change? (Yes/No)

No

@sungik-choi sungik-choi self-assigned this Mar 19, 2024
Copy link

changeset-bot bot commented Mar 19, 2024

⚠️ No Changeset found

Latest commit: 94a8229

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

github-actions bot commented Mar 19, 2024

Chromatic Report

🚀 Congratulations! Your build was successful!

Copy link

codecov bot commented Mar 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.50%. Comparing base (9802f9c) to head (94a8229).
Report is 2 commits behind head on alpha.

Additional details and impacted files
@@           Coverage Diff           @@
##            alpha    #2094   +/-   ##
=======================================
  Coverage   87.50%   87.50%           
=======================================
  Files         126      126           
  Lines        2544     2544           
  Branches      785      785           
=======================================
  Hits         2226     2226           
+ Misses        312      288   -24     
- Partials        6       30   +24     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sungik-choi sungik-choi changed the title [WIP] test(dialog-primitive): add story docs(primitives): add storybook documentation Mar 19, 2024
@sungik-choi sungik-choi added the documentation Issue or PR that improvements or additions to documentation label Mar 19, 2024
@@ -37,7 +38,7 @@ export default {
* `react-docgen-typescript-plugin` introduces significant overhead
* when HMR is enabled, so we enable it only in production.
*/
reactDocgen: process.env.NODE_ENV === 'production' && 'react-docgen-typescript',
reactDocgen: 'react-docgen-typescript',
Copy link
Collaborator

Choose a reason for hiding this comment

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

바로 위에 주석도 같이 없어지면 좋을 것 같아요

Copy link
Contributor Author

Choose a reason for hiding this comment

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

변경사항에 잘못 포함되었네요.. 롤백해두겠습니다

@sungik-choi sungik-choi merged commit 67d6f4b into channel-io:alpha Mar 20, 2024
11 checks passed
@sungik-choi sungik-choi deleted the test/primitives branch March 20, 2024 07:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issue or PR that improvements or additions to documentation
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants