UTDNebula/utd-trends

[Internal]: Add Documentation for every component

Open

#182 opened on Aug 31, 2024

View on GitHub
 (4 comments) (0 reactions) (0 assignees)TypeScript (35 forks)auto 404
Good First IssueStatus: On HoldType: DocumentationType: Internal

Repository metrics

Stars
 (28 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Contributor guide

Research direction
Examine the existing Carousel README as a template, then run npm run docs to preview your changes. Add README files and inline comments to the Icon Components listed in the sub issues.
Tech stack
typescriptreact
Domain
frontend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Gitnpm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80