Skip to content

Commit 29cf9f0

Browse files
authored
Remove all deprecated recipes + update MCP tool guidance (#1400)
* update primer_brand_review guardrails * update annotation * remove all non-flex-suite recipes * add more evals guidance
1 parent 9b5ffea commit 29cf9f0

191 files changed

Lines changed: 332 additions & 11851 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.changeset/clear-pages-compose.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
'@primer/brand-mcp': patch
3+
---
4+
5+
Improves guidance and examples delivered through the Primer Brand MCP tools:
6+
7+
- Improves guidance delivered through the `primer_brand_review` tool.
8+
- Cleaner output from the `primer_brand_examples` tool.
9+
- Add new page design guidance advising that `River` descriptions are limited to 160 characters and the default `50:50` image-to-text ratio is preferred.

apps/next-docs/content/components/River/index.mdx

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import dontVisuals from './images/dont-visuals-size.png'
1919

2020
Use rivers to showcase features and introduce topics. Rivers are composed of images or videos paired alongside text content like headings, paragraphs, and links.
2121

22-
A river’s content should be short and concise, no longer than 3 or 4 sentences and in a single paragraph when possible.
22+
A river’s content should be short and concise, no longer than 160 characters, and contained in a single paragraph when possible.
2323

2424
<DoDontContainer>
2525
<Do>
@@ -34,20 +34,9 @@ A river’s content should be short and concise, no longer than 3 or 4 sentences
3434

3535
### Stacked
3636

37-
Two or more rivers can be stacked to guide the user through a set of features. When stacking rivers, alternate between left and right alignments to create a more dynamic reading flow. When alternating alignments, use a `40:60` image to text ratio, otherwise keep the ratio to `50:50`.
37+
Two or more rivers can be stacked to guide the user through a set of features. Keep rivers in a stack consistently aligned to create a predictable reading flow. For gridline rivers, always use start alignment. Don't use zig-zag layouts.
3838

39-
It is possible to use 2 or more following left or right river to create a simple alignment promoting easy scroll scan.
40-
41-
<DoDontContainer>
42-
<Do>
43-
<img alt="" src="https://github.com/primer/brand/assets/912236/a7f8bca8-78e6-4e29-a44b-5a305ffeeeae" />
44-
<Caption>Alternate rivers with left and right alignments.</Caption>
45-
</Do>
46-
<Dont>
47-
<img alt="" src="https://github.com/primer/brand/assets/6951037/169d5c19-67f4-4f15-8e3b-80c877b34af1" />
48-
<Caption>Don't break the flow in a stack of rivers that would otherwise stay aligned.</Caption>
49-
</Dont>
50-
</DoDontContainer>
39+
Prefer the default 50:50 image-to-text ratio where possible. Use 60:40 only when the visual needs more space or emphasis.
5140

5241
Note that too many rivers can make the design feel repetitive. In that situation, consider introducing a breakout section or break the content with a different component, such as [pillar](/components/Pillar) or [card](/components/Card) to provide a better visual hierarchy and experience. For example, use the river for the top features you want to highlight and then use pillars to showcase the rest.
5342

@@ -179,7 +168,7 @@ The image is automatically styled to fit the width of the parent container. If y
179168

180169
- We recommend using a river left as the first river of the flow to start with a visual and avoid stacking text with above section on mobile
181170
- River components stacks create a unit, the set should be considered to be the main parent section. The parent section should be spaced as a regular section with the largest spacing while internal elements should use smaller spacing
182-
- If the image is critical for the user to understand the message, default to right aligned. If the text is critical for the user to understand the image, choose left aligned.
171+
- For a standalone river, choose its alignment based on whether the visual or text needs emphasis. Keep every river in a stack consistently aligned.
183172

184173
### Link
185174

packages/e2e/scripts/playwright/axe-clean.spec.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,6 @@ const testsToSkip = [
4040
'components-videoplayer-features--with-poster', // video makes this too flakey
4141
'components-videoplayer-features--without-branding', // video makes this too flakey
4242
'components-videoplayer--playground', // video makes this too flakey
43-
'recipes-feature-previews-level-1--level-one-side-by-side-enterprise', // video makes this too flakey
44-
'recipes-feature-previews-level-1--level-one-side-by-side', // custom, unrelated background image
4543
'components-eyebrowbanner-features--on-custom-background-dark', // custom, unrelated background image
4644
'components-eyebrowbanner-features--on-custom-background-light', // custom, unrelated background image
4745
'components-subdomainnavbar--skip-to-main-tag', // contains main tag which is in conflict with the default role="main" element
@@ -60,7 +58,7 @@ const testsToSkip = [
6058

6159
const ignoreViolations = {
6260
'landmark-one-main': {except: []}, // on most of the stories we don't have a main landmark
63-
'page-has-heading-one': {except: ['components-hero', 'recipes-feature-previews']}, // on some stories we dont have a heading,
61+
'page-has-heading-one': {except: ['components-hero']}, // on some stories we dont have a heading,
6462
region: {except: []}, // on most of the stories we don't have a region landmark
6563
}
6664

packages/e2e/scripts/playwright/playwright.generate-tests.ts

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -65,41 +65,11 @@ const waitForTimeoutLookup = {
6565
'components-box-features--animation': 6000, // for the animation
6666
'components-ide--playground': 2000, // for the animation
6767
'components-ide--default': 2000, // for the animation
68-
'recipes-seo-article-page--playground': 5000, // for the animation
69-
'recipes-seo-article-page--all-headings': 5000, // for the animation
70-
'recipes-seo-article-page--ai-theme': 5000, // for the animation
71-
'recipes-seo-article-page--collaboration-theme': 5000, // for the animation
72-
'recipes-seo-article-page--enterprise-theme': 5000, // for the animation
73-
'recipes-seo-article-page--security-theme': 5000, // for the animation
74-
'recipes-seo-article-page--productivity-theme': 5000, // for the animation
75-
'recipes-seo-article-page--light-hero-image': 5000, // for the animation
76-
'recipes-seo-article-page--dark-hero-image': 5000, // for the animation
77-
'recipes-solutions-categorypage--light': 4000, // for the animation
78-
'recipes-solutions-categorypage--dark': 4000, // for the animation
79-
'recipes-solutions-solution-industry--maximum': 3500, // for the animation
80-
'recipes-solutions-solution-industry--maximum-dark': 3500, // for the animation
81-
'recipes-solutions-solution-industry--minimum': 3500, // for the animation
82-
'recipes-solutions-solution-industry--minimum-dark': 3500, // for the animation
83-
'recipes-solutions-solution-org-size--maximum': 3500, // for the animation
84-
'recipes-solutions-solution-org-size--maximum-dark': 3500, // for the animation
85-
'recipes-solutions-solution-org-size--minimum': 3500, // for the animation
86-
'recipes-solutions-solution-org-size--minimum-dark': 3500, // for the animation
87-
'recipes-solutions-solution-use-case--minimum': 2000, // for the footer logos
88-
'recipes-solutions-solution-use-case--minimum-dark': 2000, // for the footer logos
89-
'recipes-solutions-solution-use-case--maximum-dark': 2000, // for the footer logos
90-
'recipes-solutions-solution-use-case--maximum': 2000, // for the footer logos
91-
'recipes-solutions-overview--light': 3500, // for the animation
92-
'recipes-solutions-overview--dark': 3500, // for the animation
9368
'components-riverstoryscroll--default': 3500, // for the animation
9469
'components-riverstoryscroll-features--with-timeline': 3500, // for the animation
9570
'components-riverstoryscroll-features--with-timeline-narrow': 3500, // for the animation
9671
'components-riverstoryscroll-features--enterprise-example': 3500, // for the animation
9772
'components-riverstoryscroll-features--enterprise-example-narrow': 3500, // for the animation
98-
'recipes-feature-previews-level-2--level-two-playground': 4000, // for the animation
99-
'recipes-feature-previews-level-2--level-two-point-one': 4000, // for the animation
100-
'recipes-feature-previews-level-2--level-two-point-two': 4000, // for the animation
101-
'recipes-feature-previews-level-2--level-two-point-three': 4000, // for the animation
102-
'recipes-feature-previews-level-2--level-two-point-four': 4000, // for the animation
10373
'components-textrevealanimation--playground': 3000, // for the animation
10474
'components-textrevealanimation-examples--with-large-testimonial': 3000, // for the animation
10575
'components-textrevealanimation-examples--with-hero': 3000, // for the animation
@@ -131,9 +101,7 @@ const waitForTimeoutLookup = {
131101
'components-videoplayer-features--tooltip-visible-on-focus': 5000, // for video metadata to load
132102
'components-hero-features-images-and-videos--with-video-block-end-default': 5000, // for video metadata to load
133103
'components-hero-features-images-and-videos--with-video-inline-end': 5000, // for video metadata to load
134-
'recipes-flextemplate-flextemplate--default': 4000, // for video metadata to load
135104
'components-textcursoranimation--playground': 4000, // for the animation to complete
136-
'recipes-flextemplate-flexsection--default': 1000, // longer load time
137105
'components-subnav-features--delayed-active-link': 2000, // because the story sets an initial delay,
138106
'components-logosuite-features--grid-line-expressive-kitchen-sink': 3000, // for the animation to complete
139107
'components-logosuite-features--takeover-button': 3000, // for the animation to complete
@@ -177,7 +145,6 @@ const skipTestLookup = [
177145
'components-logosuite-features--mixed-width', // animation only
178146
'components-logosuite-features--following-hero', // animation only
179147
'components-logosuite-features--stacked', // animation only
180-
'recipes-feature-previews-level-1--level-one-side-by-side-enterprise', // video makes this too flakey
181148
'components-subdomainnavbar--overflow-menu-open', // flakey despite timeout
182149
'components-ide-features--editor-only', // animation too long
183150
'components-ide-features--editor-no-replay-button', // animation too long
@@ -187,7 +154,6 @@ const skipTestLookup = [
187154
'components-ide-features--perspective-example-light', // animation too long
188155
'components-ide-features--all-glass', // animation too long
189156
'components-ide-features--editor-custom-icons', // animation too long
190-
'recipes-seo-category-page--default', // template contains randomisation
191157
'components-statistic-features--animations', // animation only
192158
'components-riverstoryscroll-features--video-narrow', // video makes this too flakey
193159
'components-riverstoryscroll-features--video', // video makes this too flakey

0 commit comments

Comments
 (0)