UTDNebula/utd-trends

[Internal]: Add Documentation for every component

オープン

#182 opened on 2024/08/31

 (4 件のコメント) (0 件のリアクション) (0 人の担当者)TypeScript (35 件のフォーク)auto 404
Good First IssueStatus: On HoldType: DocumentationType: Internal

Repository metrics

Stars
 (28 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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

コントリビューターガイド