Skip to content

[docs] Improve migration guides to link raw markdown format for AI #17210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 22, 2025
Merged

[docs] Improve migration guides to link raw markdown format for AI #17210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0bb420c
serve migration guides in raw markdown format
cherniavskii Mar 31, 2025
1186cb3
Merge branch 'master' into migration-guide-md-version
cherniavskii Apr 1, 2025
649a938
Merge branch 'master' into migration-guide-md-version
cherniavskii Apr 7, 2025
4e00f66
Merge branch 'master' into migration-guide-md-version
cherniavskii Apr 9, 2025
11d9870
Merge branch 'master' into migration-guide-md-version
cherniavskii Apr 21, 2025
efb0069
link to md files on GitHub
cherniavskii Apr 21, 2025
03909fd
remove copy md script
cherniavskii Apr 21, 2025
121d79b
Merge branch 'master' into migration-guide-md-version
alexfauquette Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/data/migration/migration-charts-v7/migration-charts-v7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: React Charts - Migration from v7 to v8
productId: x-charts
---

Expand All @@ -17,6 +18,10 @@ With the v8 you can now:
- Easily customize the legend since it's now an HTML element, and not a SVG one (see the [new legend docs](/x/react-charts/legend/#customization)).
- Simplified customization of the tooltip with a [new DX](#renaming-tooltip-slots-and-props) and [more demos](/x/react-charts/tooltip/#overriding-content-2).

:::success
This guide is also available in <a href="https://raw.githubusercontent.com/mui/mui-x/refs/heads/master/docs/data/migration/migration-charts-v7/migration-charts-v7.md" target="_blank">Markdown format</a> to be referenced by AI tools like Copilot or Cursor to help you with the migration.
:::

## Start using the new release

In `package.json`, change the version of the charts package to `latest`.
Expand Down
5 changes: 5 additions & 0 deletions docs/data/migration/migration-data-grid-v7/migration-data-grid-v7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ productId: x-data-grid

This is a reference guide for upgrading `@mui/x-data-grid` from v7 to v8.

:::success
This guide is also available in <a href="https://raw.githubusercontent.com/mui/mui-x/refs/heads/master/docs/data/migration/migration-data-grid-v7/migration-data-grid-v7.md" target="_blank">Markdown format</a> to be referenced by AI tools like Copilot or Cursor to help you with the migration.
:::

## Start using the new release

In `package.json`, change the version of the Data Grid package to `latest`.
Expand Down Expand Up @@ -402,3 +406,4 @@ You have to import it from `@mui/x-license` instead:
<!-- ### Editing

TBD
-->
5 changes: 5 additions & 0 deletions docs/data/migration/migration-pickers-v7/migration-pickers-v7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: React Date Pickers - Migration from v7 to v8
productId: x-date-pickers
---

Expand All @@ -10,6 +11,10 @@ productId: x-date-pickers

This is a reference guide for upgrading `@mui/x-date-pickers` from v7 to v8.

:::success
This guide is also available in <a href="https://raw.githubusercontent.com/mui/mui-x/refs/heads/master/docs/data/migration/migration-pickers-v7/migration-pickers-v7.md" target="_blank">Markdown format</a> to be referenced by AI tools like Copilot or Cursor to help you with the migration.
:::

## Start using the new release

In `package.json`, change the version of the date pickers package to `latest`.
Expand Down
5 changes: 5 additions & 0 deletions docs/data/migration/migration-tree-view-v7/migration-tree-view-v7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: React Tree View - Migration from v7 to v8
productId: x-tree-view
---

Expand All @@ -10,6 +11,10 @@ productId: x-tree-view

This is a reference guide for upgrading `@mui/x-tree-view` from v7 to v8.

:::success
This guide is also available in <a href="https://raw.githubusercontent.com/mui/mui-x/refs/heads/master/docs/data/migration/migration-tree-view-v7/migration-tree-view-v7.md" target="_blank">Markdown format</a> to be referenced by AI tools like Copilot or Cursor to help you with the migration.
:::

## Start using the new release

In `package.json`, change the version of the Tree View package to `latest`.
Expand Down
4 changes: 4 additions & 0 deletions docs/data/migration/usage-with-material-ui-v5-v6/usage-with-material-ui-v5-v6.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ title: Usage with Material UI v5 and v6

<p class="description">This guide describes the changes needed to use MUI X v8 with Material UI v5/v6.</p>

:::success
This guide is also available in <a href="https://raw.githubusercontent.com/mui/mui-x/refs/heads/master/docs/data/migration/usage-with-material-ui-v5-v6/usage-with-material-ui-v5-v6.md" target="_blank">Markdown format</a> to be referenced by AI tools like Copilot or Cursor to help you with the migration.
:::

## Package layout changes

MUI X v8 packages have been updated to use the [Node.js `exports` field](https://nodejs.org/api/packages.html#exports), following [Material UI v7 package layout changes](https://mui.com/system/migration/upgrade-to-v7/#package-layout).
Expand Down