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 合并指标
 (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

贡献者指南