Skip to content

Commit 1f3f85f

Browse files
committed
docs: improve migration guides
1 parent 62824f9 commit 1f3f85f

File tree

2 files changed

+7
-23
lines changed

2 files changed

+7
-23
lines changed

docs/pages/migration/migration-v3.mdx

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
# Migrating from v2 to v3
22

3-
### Updating your dependencies
4-
5-
The very first thing you will need to do is to update your dependencies.
6-
7-
#### Update version
3+
### Update version
84

95
```bash
106
npm install @textea/json-viewer@^3.0.0
@@ -19,7 +15,7 @@ Starting from v3, these dependencies are no longer included in the package's dep
1915
npm install @mui/material @emotion/react @emotion/styled
2016
```
2117

22-
### Handling breaking changes
18+
### Breaking changes
2319

2420
#### Check browser compatibility
2521

docs/pages/migration/migration-v4.mdx

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,15 @@
11
# Migrating from v3 to v4
22

3-
### Updating your dependencies
4-
5-
- Update `@mui/material` to `^6.0.0`
6-
7-
For `MUI` users, you can also check the [MUI v6 migration guide](https://mui.com/material-ui/migration/upgrade-to-v6/).
8-
9-
#### Update version
3+
### Update version
104

115
```bash
126
npm install @textea/json-viewer@^4.0.0
7+
npm install @mui/material@^6.0.0
138
```
149

15-
#### Install peer dependencies
16-
17-
This package is using [Material-UI](https://mui.com/) as the base component library, so you need to install it and its peer dependencies.
18-
Starting from v3, these dependencies are no longer included in the package's dependencies.
19-
20-
```bash
21-
npm install @mui/material @emotion/react @emotion/styled
22-
```
10+
For `MUI` users, you should also check the [MUI v6 migration guide](https://mui.com/material-ui/migration/upgrade-to-v6/).
2311

24-
### Handling breaking changes
12+
### Breaking changes
2513

2614
#### Check browser compatibility
2715

@@ -38,4 +26,4 @@ The minimum supported version of TypeScript has been increased from `v3.5` to `v
3826

3927
`createDataType` has been deprecated in v3 and removed in v4. Use `defineDataType` instead.
4028

41-
For more information, please refer to [V3 migration guide](/migration/migration-v3#use-definedatatype-instead-of-createdatatype).
29+
For more information, please refer to [V3 Migration Guide](/migration/migration-v3#use-definedatatype-instead-of-createdatatype).

0 commit comments

Comments
 (0)