Apply suggestions from code review

sumup-oss · Aug 21, 2024 · d22fd1b · d22fd1b
1 parent fe3b268
commit d22fd1b
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 3 deletions.
diff --git a/docs/features/1-theme.mdx b/docs/features/1-theme.mdx
@@ -61,7 +61,7 @@ Use spacings for gutters, margins, and paddings. Don't use it for border width,
 
 ## Typography
 
-Avoid using the `var(--cui-typography-*)` CSS custom properties directly in your styles. Instead, use the typography components [`Display`](Typography/Display/Docs), [`Headline`](Typography/Headline/Docs), [`SubHeadline`](Typography/SubHeadline/Docs), [`Body`](Typography/Body/Docs), and [`BodyLarge`](Typography/BodyLarge/Docs).
+Avoid using the `var(--cui-typography-*)` CSS custom properties directly in your styles. Instead, use the typography components [`Display`](Typography/Display/Docs), [`Headline`](Typography/Headline/Docs), and [`Body`](Typography/Body/Docs).
 
 <CustomPropertiesTable namespace="typography" preview={Typography} />
 

diff --git a/packages/circuit-ui/components/Display/Display.mdx b/packages/circuit-ui/components/Display/Display.mdx
@@ -24,4 +24,4 @@ The Display component comes in three sizes. In most cases, use the [Headline com
 
 ## Accessibility
 
-All accessibility guidelines for the [Headline component](Typography/Headline) also apply to the Display component../Display.stories
+All accessibility guidelines for the [Headline component](Typography/Headline) also apply to the Display component.
diff --git a/packages/circuit-ui/components/Headline/Headline.mdx b/packages/circuit-ui/components/Headline/Headline.mdx
@@ -18,7 +18,7 @@ The Headline component is used for describing the contents of a page or page sec
 
 The Headline component comes in three sizes.
 
-Use the `four` size for card headers and `three` for page titles in web applications. For specific use cases such as landing pages, consider using the [Display](Typography/Display) component.
+Use the `m` size for card headers and `l` for page titles in web applications. Consider using the [Display](Typography/Display) component for specific use cases such as landing pages.
 
 <Story of={Stories.Sizes} inline={false} />
 

diff --git a/packages/eslint-plugin-circuit-ui/no-deprecated-custom-properties/README.md b/packages/eslint-plugin-circuit-ui/no-deprecated-custom-properties/README.md
@@ -32,5 +32,6 @@ n/a
 
 ## Further Reading
 
+- [Theme documentation](https://circuit.sumup.com/?path=/docs/features-theme--docs) on the Circuit UI docs
 - [Migration guide](https://github.com/sumup-oss/circuit-ui/blob/main/MIGRATION.md)
 - [Design token release notes](https://github.com/sumup-oss/circuit-ui/blob/main/packages/design-tokens/CHANGELOG.md)
diff --git a/packages/stylelint-plugin-circuit-ui/no-deprecated-custom-properties/README.md b/packages/stylelint-plugin-circuit-ui/no-deprecated-custom-properties/README.md
@@ -27,3 +27,5 @@ n/a
 ## Further Reading
 
 - [Theme documentation](https://circuit.sumup.com/?path=/docs/features-theme--docs) on the Circuit UI docs
+- [Migration guide](https://github.com/sumup-oss/circuit-ui/blob/main/MIGRATION.md)
+- [Design token release notes](https://github.com/sumup-oss/circuit-ui/blob/main/packages/design-tokens/CHANGELOG.md)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -24,4 +24,4 @@ The Display component comes in three sizes. In most cases, use the [Headline com

		## Accessibility

		All accessibility guidelines for the [Headline component](Typography/Headline) also apply to the Display component../Display.stories
		All accessibility guidelines for the [Headline component](Typography/Headline) also apply to the Display component.