Audit: How many components do not have storybook stories-new (#597) #622
There are no files selected for viewing
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> | ||
|
There was a problem hiding this comment. What are we using to consider a story insufficient? There was a problem hiding this comment. There are components with previous Stories written that must meet Shashi's standards. The 'Insufficient Storyfield' allows us to identify current and future Stories that must be rewritten to meet the required standards. (Per Shashi, we will be following the carbon design system for GIS Story standards) |
||
| <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> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please make this table using mdx syntax. To find out more, please look at table mdx syntax
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current syntax is valid MDX for the table and is much easier to maintain, as we will continually add components. This syntax also makes Tailwind available to add background colors and additional formatting easily.
Shashi already approved my current version, but I will revise it if he changes his mind.