UTDNebula/utd-trends

[Internal]: Add Documentation for every component

開放

#182 建立於 2024年8月31日

 (4 則留言) (0 個反應) (0 位負責人)TypeScript (35 個分叉)auto 404
Good First IssueStatus: On HoldType: DocumentationType: Internal

倉庫指標

星標
 (28 顆星)
PR 合併指標
 (平均合併 16天 20小時) (30 天內合併 1 個 PR)

描述

Overview

Ensure every component's README has accurate documentation about what the component is and how it is used For the README's, basic requirements are: (a) where the component is used in the UI, (b) what data is being passed in, (c) what the component is doing (the javascript mainly)

Also include in-line comments to explain how functions work

Look at src\components\navigation\Carousel\README.md as a reference and see results by running npm run docs and going to http://localhost:6060 in your browser.

Sub-issues:

  • Add documentation to the React StyleGuide for Icon Components

貢獻者指南