-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Audit: How many components do not have storybook stories (#597)
- [x] Added an mdx doc to identify components lacking comprehensive Storybook stories. Closes #597.
- Loading branch information
Larocca
authored and
Larocca
committed
Oct 25, 2024
1 parent
a267371
commit 74551bb
Showing
1 changed file
with
230 additions
and
0 deletions.
There are no files selected for viewing
230 changes: 230 additions & 0 deletions
230
...ies/Technical Planning Documents/Audit of Storybook Component Documentation.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,230 @@ | ||
| import '../styles.css'; | ||
|
|
||
| # Audit of Storybook Component Documentation | ||
|
|
||
| #### By Michael Larocca - github: [@MichaelLarocca](https://github.com/MichaelLarocca) | ||
|
|
||
| --- | ||
|
|
||
| ## About | ||
|
|
||
| #### **This documentation provides an overview of the audit process to identify components lacking comprehensive Storybook stories. The goal is to ensure all components are thoroughly documented and tested within Storybook, enhancing our codebase's overall quality and maintainability.** | ||
|
|
||
| ### Components | ||
|
|
||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Component Name</th> | ||
| <th>Sufficient Story</th> | ||
| <th>Insufficient Story</th> | ||
| <th>Missing Story</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>AdminHeader</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>AdminLogo</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>AdminNav</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>AdminQuickMenu</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>AdminUserSettings</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Alert</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>AlertDescription</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>AlertNotification</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>AlertTitle</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Button</td> | ||
| <td className="bg-green-100 text-center font-bold">X</td> | ||
| <td></td> | ||
| <td></td> | ||
| </tr> | ||
| <tr> | ||
| <td>EliminatedStatus</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>EntryStatus</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Form</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>GlobalSpinner</td> | ||
| <td></td> | ||
| <td className="bg-yellow-100 text-center font-bold">X</td> | ||
| <td></td> | ||
| </tr> | ||
| <tr> | ||
| <td>Heading</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Input</td> | ||
| <td className="bg-green-100 text-center font-bold">X</td> | ||
| <td></td> | ||
| <td></td> | ||
| </tr> | ||
| <tr> | ||
| <td>Label</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>LeagueCard</td> | ||
| <td className="bg-green-100 text-center font-bold">X</td> | ||
| <td></td> | ||
| <td></td> | ||
| </tr> | ||
| <tr> | ||
| <td>LeagueEntries</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>LeagueSurvivors</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>LinkCustom</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>LoadingSpinner</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Logo</td> | ||
| <td className="bg-green-100 text-center font-bold">X</td> | ||
| <td></td> | ||
| <td></td> | ||
| </tr> | ||
| <tr> | ||
| <td>LogoNav</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Nav</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>NavDrawer</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>RadioGroup</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>RestPasswordForm</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Table</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>TableColumns</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>TableData</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>TableDropDownMenu</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>UpdateEmailForm</td> | ||
| <td></td> | ||
| <td></td> | ||
| <td className="bg-red-100 text-center font-bold">X</td> | ||
| </tr> | ||
| <tr> | ||
| <td>WeeklyPickButton</td> | ||
| <td className="bg-green-100 text-center font-bold">X</td> | ||
| <td></td> | ||
| <td></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> |