Skip to content

Commit 16363f3

Browse files
mapache-salvajemapache-salvaje
andauthored
[docs] Link to agent skills in relevant docs (mui#48387)
Co-authored-by: mapache-salvaje <mapache@salvaje.com>
1 parent 7e48786 commit 16363f3

14 files changed

Lines changed: 48 additions & 12 deletions

File tree

docs/data/material/customization/css-theme-variables/overview.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ You can implement them to improve Material UI's theming and customization exper
99
If this is your first time encountering CSS variables, you should check out [the MDN Web Docs on CSS custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Guides/Cascading_variables/Using_custom_properties) before continuing here.
1010
:::
1111

12+
:::success
13+
Use the [Material UI theming agent skill](https://github.com/mui/material-ui/tree/master/skills/material-ui-theming) to give your AI coding assistant full context on CSS theme variables, `theme.vars`, and SSR flicker prevention.
14+
:::
15+
1216
## Introduction
1317

1418
CSS theme variables replace raw values in Material UI components for a better developer experience because, in the browser dev tool, you will see which theme token is used as a value.

docs/data/material/customization/dark-mode/dark-mode.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
<p class="description">Material UI comes with two palette modes: light (the default) and dark.</p>
44

5+
:::success
6+
Use the [Material UI theming agent skill](https://github.com/mui/material-ui/tree/master/skills/material-ui-theming) to give your AI coding assistant full context on dark mode, color schemes, and SSR behavior.
7+
:::
8+
59
## Dark mode only
610

711
You can make your application use the dark theme as the default—regardless of the user's preference—by adding `mode: 'dark'` to the `createTheme()` helper:

docs/data/material/customization/how-to-customize/how-to-customize.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ Material UI provides several different ways to customize a component's styles.
1414
1. [Global theme overrides](#3-global-theme-overrides)
1515
1. [Global CSS override](#4-global-css-override)
1616

17+
:::success
18+
Use the [Material UI styling agent skill](https://github.com/mui/material-ui/tree/master/skills/material-ui-styling) to give your AI coding assistant guidance on choosing between `sx`, `styled()`, theme overrides, and global CSS.
19+
:::
20+
1721
## 1. One-off customization
1822

1923
To change the styles of _one single instance_ of a component, you can use one of the following options:

docs/data/material/customization/theming/theming.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ Themes let you apply a consistent tone to your app. It allows you to **customize
88

99
To promote greater consistency between apps, light and dark theme types are available to choose from. By default, components use the light theme type.
1010

11+
:::success
12+
Use the [Material UI theming agent skill](https://github.com/mui/material-ui/tree/master/skills/material-ui-theming) to give your AI coding assistant full context on `createTheme`, palette, color schemes, CSS variables, and TypeScript augmentation.
13+
:::
14+
1115
## Theme provider
1216

1317
Material UI components adhere to the library's default theme out of the box.

docs/data/material/integrations/nextjs/nextjs.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
<p class="description">Learn how to use Material UI with Next.js.</p>
44

5+
:::success
6+
Use the [Material UI + Next.js agent skill](https://github.com/mui/material-ui/tree/master/skills/material-ui-nextjs) to give your AI coding assistant full context on this integration, including App Router, SSR cache providers, `next/font`, and CSS layers.
7+
:::
8+
59
## App Router
610

711
This section walks through the Material UI integration with the Next.js [App Router](https://nextjs.org/docs/app), an evolution of the [Pages Router](#pages-router), and, currently, the recommended way of building new Next.js applications starting from version 13.

docs/data/material/integrations/tailwindcss/tailwindcss-v4.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ There are two steps to integrate Tailwind CSS v4 with Material UI:
1111

1212
The instructions below detail how to achieve this using common React frameworks.
1313

14+
:::success
15+
Use the [Material UI + Tailwind CSS agent skill](https://github.com/mui/material-ui/tree/master/skills/material-ui-tailwind) to give your AI coding assistant full context on this integration, including CSS layer ordering, `enableCssLayer`, and Tailwind class overrides.
16+
:::
17+
1418
### Next.js App Router
1519

1620
To integrate Tailwind CSS v4 with Material UI in a Next.js App Router project, start by configuring Material UI with Next.js in the [App Router integration guide](/material-ui/integrations/nextjs/#app-router).

skills/material-ui-nextjs/AGENTS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Material UI and Next.js
22

3-
Version 1.0.0
3+
Version 1.0.0 (Material UI v9)
4+
5+
> **Version notice:** This skill targets Material UI v9 (`>=9.0.0 <10.0.0`). If you are using a different major version, verify the API details before following this guidance.
46
57
> Note: This document is for agents and LLMs integrating Material UI with Next.js. Source: `docs/data/material/integrations/nextjs/nextjs.md` and related integration docs in this repository.
68

skills/material-ui-nextjs/metadata.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
22
"version": "1.0.0",
3-
"organization": "Material UI",
4-
"abstract": "Documents Next.js integration for Material UI: AppRouterCacheProvider and Pages Router Document/App cache wiring, Emotion options, next/font with themes, CSS theme variables and SSR flicker pointers, enableCssLayer for Tailwind/CSS Modules, and Next.js Link client-wrapper patterns.",
3+
"muiVersion": ">=9.0.0 <10.0.0",
4+
"organization": "Material UI",
5+
"abstract": "Documents Next.js integration for Material UI: AppRouterCacheProvider and Pages Router Document/App cache wiring, Emotion options, next/font with themes, CSS theme variables and SSR flicker pointers, enableCssLayer for Tailwind/CSS Modules, and Next.js Link client-wrapper patterns.",
56
"references": [
67
"https://mui.com/material-ui/integrations/nextjs.md",
78
"https://mui.com/material-ui/integrations/routing.md",

skills/material-ui-styling/AGENTS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Material UI styling
22

3-
Version 1.0.0
3+
Version 1.0.0 (Material UI v9)
4+
5+
> **Version notice:** This skill targets Material UI v9 (`>=9.0.0 <10.0.0`). If you are using a different major version, verify the API details before following this guidance.
46
57
> Note: This document is for agents and LLMs maintaining or generating Material UI code. It follows [How to customize](https://mui.com/material-ui/customization/how-to-customize.md) and related sources in this repository (`docs/data/material/customization/`, `docs/data/system/`).
68

skills/material-ui-styling/metadata.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
22
"version": "1.0.0",
3-
"organization": "Material UI",
4-
"abstract": "Guides selection of Material UI styling strategies from narrowest to broadest scope (sx, styled, theme.components, GlobalStyles/CssBaseline), including slot/state overrides and sx vs styled foot-guns.",
3+
"muiVersion": ">=9.0.0 <10.0.0",
4+
"organization": "Material UI",
5+
"abstract": "Guides selection of Material UI styling strategies from narrowest to broadest scope (sx, styled, theme.components, GlobalStyles/CssBaseline), including slot/state overrides and sx vs styled foot-guns.",
56
"references": [
67
"https://mui.com/material-ui/customization/how-to-customize.md",
78
"https://mui.com/system/getting-started/the-sx-prop.md",

0 commit comments

Comments
 (0)