docs: nest component recipes under components #1715
Conversation
size-limit report 📦
|
booc0mtaco
added
the
do not merge
|
Holding merge on this one until #1713 has merged (so we can remove the recipes used in the soon-to-be-deleted pages) |
|
Does this mean we won't have the |
Correct. After looking thru things, having the recipes broken out as we were doing created two kinds of confusion:
For these implementation examples, there's usually a "main component" and subordinate components used to demonstrate how to use it. This gets us to a spot where we can be more clear on what the word "recipe" means outside of consuming projects. Happy to chat more about this, as it seemed MOSTLY clear to me as I sorted thru approaches! |
| @@ -59,3 +74,181 @@ export const Dragging: StoryObj<Args> = { | |||
| elevation: 'dragging', | |||
| }, | |||
| }; | |||
|
|
|||
| export const ButtonActionCalloutCard: StoryObj<Args> = { | |||
There was a problem hiding this comment.
Wait what about putting the recipes under {component}/recipes/ via title: 'Components/Card/recipes or do you think the badge does the job?
There was a problem hiding this comment.
could also consider always naming the stories "xx Example"
There was a problem hiding this comment.
These could work, actually. I wanted to lean away from using that Recipe word in EDS, so we didn't create ambiguity on what a recipe is. but it may make sense to separate out these stories from the more normal stories.
Let's have a chat about that in our next sync :) I can create a ticket with some options to prep discussion.
|
Gonna expand this one just a touch to include the now-unused recipes along with the generators for new recipes and pages to close the loop |
booc0mtaco
force-pushed
the
aholloway/EDS-1085
branch
from
1cd1764
to
ceb6ec4
Compare
booc0mtaco
removed
the
do not merge
Codecov Report
@@ Coverage Diff @@
## next #1715 +/- ##
==========================================
- Coverage 92.47% 92.28% -0.20%
==========================================
Files 143 146 +3
Lines 2498 2579 +81
Branches 640 664 +24
==========================================
+ Hits 2310 2380 +70
+ Misses 187 183 -4
- Partials 1 16 +15
... and 6 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
- move individual implementation examples under related components - label them as such - note: some recipes are used in stories, which breaks convention - update snapshots - remove plop integrations for creating new recipes and pages - remove lingering recipes
booc0mtaco
force-pushed
the
aholloway/EDS-1085
branch
from
ceb6ec4
to
d9fb2b4
Compare
Summary:
Recipes used in other recipes and pages are pending removal. As a reminder to the bigger context... canonical recipes are those which are specific to a product and will live within the product's storybook/documentation. implementation examples are sandboxed code examples that are composed of a set of other EDS components which might describe a recommended layout. As examples, they are not exported, so we move them alongside other examples in storybook to reduce confusion.
Test Plan: