UTDNebula/utd-trends

[Internal]: Add documentation to the React StyleGuide for Dashboard components

Open

#492 opened on Sep 3, 2025

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

Repository metrics

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

Description

Add documentation to the page for the components in our React StyleGuideIst. For a reference, see the documentation for the Carousel component. See https://github.com/UTDNebula/utd-trends/issues/182#issue-2498557609 for more info about the styleguide.

Dashboard Components: DashboardEmpty DashboardError Tutorial

Contributor guide

Research direction
Read the documentation for the Carousel component to understand the format, then add similar documentation for DashboardEmpty, DashboardError, and Tutorial components.
Tech stack
typescriptreact
Domain
frontenddocumentation
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75