openedx / openedx/paragon

Add "Customizing using className" sections to the component pages on the Paragon docs site

Open
#3,785 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

docs documentation ready for discussion
Dominant language
JavaScript
Stars
140
Forks
100
Avg merge
1h 3m
Merged PRs (30d)
30

Description

Description

We are considering introducing component-level documentation for all Paragon components that support the className prop. This would include dedicated sections with usage examples and best practices for customizing styling via className.

Support documentation

This list includes Paragon components that support the className prop, along with multiple usage examples for each. Each section is organized by component name and contains links to some usage instances across Open edX repositories.

ActionRow

Alert

AlertModal

Avatar

Badge

Breadcrumb

Bubble

Button

ButtonGroup

Card

Chip

Collapsible

Container

DataTable

Dropdown

Dropzone

Form

Form.Checkbox

Form.Control

Form.Control.Feedback

Form.Group

Form.Label

Form.Radio

Form.Switch

FullscreenModal

Hyperlink

Icon

IconButton

Image

Layout

MailtoLink

MarketingModal

Menu

MenuItem

ModalDialog

Nav

Navbar

Pagination

Popover

ProgressBar

Scrollable

SearchField

SelectMenu

SelectableBox

Skeleton

Spinner

Stack

StatefulButton

Stepper

Sticky

Tabs

Toast

Tooltip

TransitionReplace

Additional context

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the component pages on the Paragon docs site and the support-documentation list in this issue, then identify how existing usage sections are structured. Done means adding a "Customizing using className" section with examples and best practices to every listed component page that supports the prop.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation, frontend
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.