Write documentation

[sungik-choi]

Description

파운데이션, 컴포넌트에 대한 문서(mdx, JSDoc)을 작성해야합니다.

Reasons for suggestion

라이브러리 사용자와 메인테이너(채널 멤버)에게 파운데이션, 컴포넌트의 올바른 사용법을 알려주기 위해서 문서화를 진행합니다.

Proposed solution

• 문서를 작성하고자하는 메인테이너는 먼저 이슈(e.g. Write documentation for FormControl and related components #988)를 생성해주세요.
• 해당 모듈을 구현한 엔지니어가 문서도 함께 작성해주시길 기대합니다.
• 컴포넌트를 재구현하는 경우, 문서화를 함께 진행합니다.

Components

Preview Give feedback

1. Add mdx documentation for Avatars component group #880
   documentation +1
   
2. Write mdx documentation for Banner component #808
   +0
3. Write mdx documentation for Button component #811
   +0
4. Write documentation for ButtonGroup component #984
   documentation +1
   
5. Write documentation for Divider component #985
   documentation status:pending +2
6. Write documentation for Emoji component #986
   documentation status:pending +2
   
7. Write documentation for Checkbox component #987
   documentation status:pending +2
8. Write documentation for FormControl and related components #988
   documentation status:pending +2
   
9. Re-implement Select component using Dropdown Menu in Radix UI #980
   #reimplementation a11y enhancement priority:A status:duplicate status:pending +6
   
10. Write documentation for TextArea component #990
    documentation status:pending +2
11. Write documentation for TextField component #991
    documentation status:pending +2
12. Re-implement Radio component using RadioGroup in Radix UI #709
    #reimplementation a11y enhancement +3
    
13. Write documentation for SegmentedControl component #992
    documentation status:pending +2
14. Write documentation for Slider component
15. Write documentation for Switch component
16. Re-implement Switch component using Switch in Radix UI #711
    #reimplementation a11y enhancement +3
    
17. Write documentation for Switch component #1060
    documentation status:pending +2
    
18. Write documentation for Help component
19. Write mdx documentation for Icon component #905
    +0
20. Write documentation for KeyValueListItem component
21. Write documentation for ListItem component
22. Write documentation for ListMenuTitle component
23. Re-implement Modal, ConfirmModal component using Dialog, AlertDialog in Radix UI #978
    #reimplementation a11y enhancement +3
    
24. Write documentation for NavGroup component
25. Write documentation for NavItem component
26. Write documentation for OutlineItem component
27. Write documentation for Overlay component
28. Write documentation for ProgressBar component #1034
    documentation +1
    
29. Write documentation for SectionLabel component
30. Write documentation for Spinner component
31. Write mdx documentation for Stack components #807
    +0
32. Write documentation for Status component
33. Write documentation for Tabs component
34. Re-implement Tabs, TabItem component using Tabs in Radix UI #982
    #reimplementation a11y enhancement +3
    
35. Write documentation for Tabs component #1072
    documentation status:pending +2
    
36. Write mdx document for TagBadge component group #925
    +0
37. Write documentation for Text component
38. Write documentation for Toast component
39. Re-implement Tooltip component using Tooltip in Radix UI #979
    #reimplementation a11y enhancement +3
    

Foundation

Foundation의 경우, beizer-react 내부의 구현이 바꿀 여지가 있습니다.

References

• Apply react-docgen-typescript-plugin to generate storybook documentations from JSDoc #931
• PRs

[sungik-choi]

디자인 시스템 리빌드가 진행중이므로, 스펙 변경 여지가 있어 잠시 펜딩합니다.

[sungik-choi]

디자인 시스템 리빌드(v2)로 컴포넌트 변경이 많습니다. 기존 버전의 컴포넌트(v1)의 문서화는 큰 의미가 없다고 판단하여 관련 이슈는 Close합니다.