UTDNebula/utd-trends

[Internal]: Add documentation to the React StyleGuide for Planner Components

Open

#491 opened on Sep 3, 2025

View on GitHub
 (0 comments) (0 reactions) (1 assignee)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)[http://localhost:6060/#/Navigation%20Components?id=carousel]. See https://github.com/UTDNebula/utd-trends/issues/182#issue-2498557609 for more info about the styleguide.

Planner Components: PlannerCard PlannerCoursesTable PlannerSection PlannerSchedule PlannerEmpty

These components are not yet in the style guide, so you will have to edit styleguide.config.js as well

Contributor guide

Research direction
Examine the existing styleguide.config.js and add entries for each Planner component following the Carousel example. Then write documentation for each component in a .md file.
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.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
GitReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85