Skip to content

Commit

Permalink
[docs] Shorten overview page URLs (#37660)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliviertassinari committed Jun 23, 2023
1 parent 2a7ead1 commit 9340efd
Show file tree
Hide file tree
Showing 70 changed files with 117 additions and 113 deletions.
8 changes: 4 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9858,7 +9858,7 @@ A big thanks to the 34 contributors who made this release possible. Here are som

While the source code is currently hosted in the [main repository](https://github.com/mui/material-ui), we might move it to the [x repository](https://github.com/mui/mui-x) in the future, depending on what is easier for the commercial date range picker. The date picker will stay open source no matter what.

- 📚 Revamp the documentation for [the system](https://mui.com/system/getting-started/overview/). The System contains CSS utilities. The documentation now promotes the use of the `sx` prop. It's ideal for adding one-off styles, e.g. padding, but when pushed to its limits, it can be used to implement quickly a complete page.
- 📚 Revamp the documentation for [the system](https://mui.com/system/getting-started/). The System contains CSS utilities. The documentation now promotes the use of the `sx` prop. It's ideal for adding one-off styles, e.g. padding, but when pushed to its limits, it can be used to implement quickly a complete page.
- 👩‍🎨 Upgrade emotion to v11 (#23007) @mnajdova.
- And many more 🐛 bug fixes and 📚 improvements.

Expand Down Expand Up @@ -10260,7 +10260,7 @@ Here are some highlights ✨:
If you target IE11, you need to use the new bundle (`legacy`). We are treating IE11 as a second class-citizen, which is a continuation of the direction taken in #22873.

- 🚀 Improve the internal benchmark suite (#22923, #23058) @mnajdova.
This was a prerequisite step to improve the [system](https://mui.com/system/getting-started/overview/). We needed to be able to measure performance. After #22945, we have measured that the `Box` component is x3 faster in v5-alpha compared to v4.
This was a prerequisite step to improve the [system](https://mui.com/system/getting-started/). We needed to be able to measure performance. After #22945, we have measured that the `Box` component is x3 faster in v5-alpha compared to v4.
- ✏️ A new blog post: [Q3 2020 Update](https://mui.com/blog/2020-q3-update/) (#23055) @oliviertassinari.
- 🐙 Migrate more tests to react-testing-library @deiga, @Morteza-Jenabzadeh, @nicholas-l.
- And many more 🐛 bug fixes and 📚 improvements.
Expand Down Expand Up @@ -10601,7 +10601,7 @@ Here are some highlights ✨:

The new styling solution saves 2kB gzipped in the bundle compared to JSS, and about 14 kB gzipped if you were already using emotion or styled-components.

Last but not least, the change allows us to take advantage dynamic style props. We will use them for dynamic color props, variant props, and new style props (an improved [system](https://mui.com/system/getting-started/overview/)).
Last but not least, the change allows us to take advantage dynamic style props. We will use them for dynamic color props, variant props, and new style props (an improved [system](https://mui.com/system/getting-started/)).

This change has been in our roadmap for more than a year.
We announced it in the [v4 release blog post](https://mui.com/blog/material-ui-v4-is-out/) as a direction v5 would take.
Expand Down Expand Up @@ -11854,7 +11854,7 @@ A big thanks to the 33 contributors who made this release possible. Here are som
/>
```

- [Typography] Replace the `srOnly` prop so as to not duplicate the capabilities of [System](https://mui.com/system/getting-started/overview/) (#21413) @mnajdova.
- [Typography] Replace the `srOnly` prop so as to not duplicate the capabilities of [System](https://mui.com/system/getting-started/) (#21413) @mnajdova.

```diff
-import Typography from '@material-ui/core/Typography';
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@

**MUI Core** contains foundational React UI component libraries for shipping new features faster.

- [_Material UI_](https://mui.com/material-ui/getting-started/overview/) is a comprehensive library of components that features our implementation of Google's [Material Design](https://m2.material.io/design/introduction/) system.
- [_Material UI_](https://mui.com/material-ui/getting-started/) is a comprehensive library of components that features our implementation of Google's [Material Design](https://m2.material.io/design/introduction/) system.

- [_Joy UI_](https://mui.com/joy-ui/getting-started/overview/) is a beautifully designed library of React UI components.
- [_Joy UI_](https://mui.com/joy-ui/getting-started/) is a beautifully designed library of React UI components.

- [_Base UI_](https://mui.com/base-ui/getting-started/overview/) is our library of "unstyled" components and low-level hooks. With Base, you gain complete control over your app's CSS and accessibility features.
- [_Base UI_](https://mui.com/base-ui/getting-started/) is our library of "unstyled" components and low-level hooks. With Base, you gain complete control over your app's CSS and accessibility features.

- [_MUI System_](https://mui.com/system/getting-started/overview/) is a collection of CSS utilities to help you rapidly lay out custom designs.
- [_MUI System_](https://mui.com/system/getting-started/) is a collection of CSS utilities to help you rapidly lay out custom designs.

<div align="center">

Expand Down Expand Up @@ -177,10 +177,10 @@ Our documentation features [a collection of example projects using Material UI](

## Documentation

- [Material UI](https://mui.com/material-ui/getting-started/overview/)
- [Joy UI](https://mui.com/joy-ui/getting-started/overview/)
- [Base UI](https://mui.com/base-ui/getting-started/overview/)
- [MUI System](https://mui.com/system/getting-started/overview/)
- [Material UI](https://mui.com/material-ui/getting-started/)
- [Joy UI](https://mui.com/joy-ui/getting-started/)
- [Base UI](https://mui.com/base-ui/getting-started/)
- [MUI System](https://mui.com/system/getting-started/)

## Premium themes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ See our [Working with Tailwind CSS guide](/base-ui/guides/working-with-tailwind-

#### Styled components

If you use a CSS-in-JS solution with a styled-components-like API (such as [MUI System](/system/getting-started/overview/) or [Emotion](https://emotion.sh/docs/introduction)), the best method is to provide the styled subcomponents using the [`slots` prop](#overriding-subcomponent-slots), as shown in the [demo below](#overriding-subcomponent-slots).
If you use a CSS-in-JS solution with a styled-components-like API (such as [MUI System](/system/getting-started/) or [Emotion](https://emotion.sh/docs/introduction)), the best method is to provide the styled subcomponents using the [`slots` prop](#overriding-subcomponent-slots), as shown in the [demo below](#overriding-subcomponent-slots).

Alternatively, you can wrap the whole unstyled component in a `styled` utility and target the individual subcomponents using CSS classes:

Expand Down
4 changes: 2 additions & 2 deletions docs/data/base/getting-started/overview/overview-pt.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: Overview

## Introduction

Base UI is a library of unstyled React UI components. These components were extracted from [Material UI](/material-ui/getting-started/overview/), and are now available as a standalone package. They feature the same robust engineering but without implementing Material Design.
Base UI is a library of unstyled React UI components. These components were extracted from [Material UI](/material-ui/getting-started/), and are now available as a standalone package. They feature the same robust engineering but without implementing Material Design.

Base UI includes prebuilt components with production-ready functionality, along with low-level hooks for transferring that functionality to other components.

Expand All @@ -30,7 +30,7 @@ Look for the [`package: base`](https://github.com/mui/material-ui/labels/package

## Base UI vs. Material UI

Base UI features many of the same components as [Material UI](/material-ui/getting-started/overview/), but without the Material Design implementation.
Base UI features many of the same components as [Material UI](/material-ui/getting-started/), but without the Material Design implementation.

Base UI is not packaged with any default theme or built-in style engine. This makes it a great choice if you need complete control over how your app's CSS is implemented.

Expand Down
4 changes: 2 additions & 2 deletions docs/data/base/getting-started/overview/overview-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: Overview

## Introduction

Base UI is a library of unstyled React UI components. These components were extracted from [Material UI](/material-ui/getting-started/overview/), and are now available as a standalone package. They feature the same robust engineering but without implementing Material Design.
Base UI is a library of unstyled React UI components. These components were extracted from [Material UI](/material-ui/getting-started/), and are now available as a standalone package. They feature the same robust engineering but without implementing Material Design.

Base UI includes prebuilt components with production-ready functionality, along with low-level hooks for transferring that functionality to other components.

Expand All @@ -30,7 +30,7 @@ Look for the [`package: base`](https://github.com/mui/material-ui/labels/package

## Base UI vs. Material UI

Base UI features many of the same components as [Material UI](/material-ui/getting-started/overview/), but without the Material Design implementation.
Base UI features many of the same components as [Material UI](/material-ui/getting-started/), but without the Material Design implementation.

Base UI is not packaged with any default theme or built-in style engine. This makes it a great choice if you need complete control over how your app's CSS is implemented.

Expand Down
4 changes: 2 additions & 2 deletions docs/data/base/getting-started/overview/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: Overview
## Introduction

Base UI is a library of unstyled React UI components and low-level hooks.
These components were extracted from [Material UI](/material-ui/getting-started/overview/), and are now available as a standalone package.
These components were extracted from [Material UI](/material-ui/getting-started/), and are now available as a standalone package.
They feature the same robust engineering but without implementing Material Design.

Base UI includes prebuilt components with production-ready functionality, along with low-level hooks for transferring that functionality to other components.
Expand All @@ -34,7 +34,7 @@ Look for the [`package: base-ui`](https://github.com/mui/material-ui/labels/pack

## Base UI vs. Material UI

Base UI features many of the same components as [Material UI](/material-ui/getting-started/overview/), but without the Material Design implementation.
Base UI features many of the same components as [Material UI](/material-ui/getting-started/), but without the Material Design implementation.

Base UI is not packaged with any default theme or built-in style engine.
This makes it a great choice if you need complete control over how your app's CSS is implemented.
Expand Down
2 changes: 1 addition & 1 deletion docs/data/base/getting-started/quickstart/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ The demo below shows how to build the Primer button using Tailwind CSS:

### Styling with MUI System

[MUI System](/system/getting-started/overview/) is a small set of CSS utilties that provide a styled-components-like API for building out designs that adhere to a theme.
[MUI System](/system/getting-started/) is a small set of CSS utilties that provide a styled-components-like API for building out designs that adhere to a theme.

MUI System's core utility is a [`styled` function](/system/styled/) that's equivalent to the `styled()` function in emotion and styled-components.
Interpolations or arguments that are functions called by `styled` receive the `theme` from an upper `ThemeProvider`.
Expand Down
5 changes: 3 additions & 2 deletions docs/data/base/pages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@ import pagesApi from 'docs/data/base/pagesApi';

const pages = [
{
pathname: '/base-ui/getting-started',
pathname: '/base-ui/getting-started-group',
title: 'Getting started',
icon: standardNavIcons.DescriptionIcon,
children: [
{ pathname: '/base-ui/getting-started/overview', title: 'Overview' },
{ pathname: '/base-ui/getting-started', title: 'Overview' },
{ pathname: '/base-ui/getting-started/quickstart', title: 'Quickstart' },
{ pathname: '/base-ui/getting-started/usage', title: 'Usage' },
{ pathname: '/base-ui/getting-started/customization', title: 'Customization' },
Expand Down
2 changes: 1 addition & 1 deletion docs/data/joy/getting-started/overview/overview-pt.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Look for the [`package: joy`](https://github.com/mui/material-ui/labels/package%

- **Ship faster:** Joy UI gives you a significant amount of prebuilt components you need to develop web apps, with a sleek and carefully designed look and feel, allowing you to achieve a good-looking result without a dedicated designer.
- **Extensive customization:** you're encouraged to customize each and every tiny piece of the Joy UI components so they match your desired design.
- **Accessibility in mind:** Joy UI components are built on top of [Base UI's unstyled components and low-level hooks](/base-ui/getting-started/overview/), giving you support for several accessibility features out of the box. We do our best to make all components screen reader-friendly, also offering suggestions for optimizing accessibility throughout our documentation.
- **Accessibility in mind:** Joy UI components are built on top of [Base UI's unstyled components and low-level hooks](/base-ui/getting-started/), giving you support for several accessibility features out of the box. We do our best to make all components screen reader-friendly, also offering suggestions for optimizing accessibility throughout our documentation.

## Joy UI vs. Material UI

Expand Down
2 changes: 1 addition & 1 deletion docs/data/joy/getting-started/overview/overview-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Look for the [`package: joy`](https://github.com/mui/material-ui/labels/package%

- **更快交付:** Joy UI 给了您大量你开发网页应用所需的预定义组件, 圆润而细致的外观感,让你能够在没有设计师的情况下取得很好的结果。
- **深度自定义:** 你可以自定义 Joy UI 每一个小块组件,使得它们符合你的设计风格。
- **可访问性:** Joy UI 是建立在 [Base UI 的无样式基础组件和低级钩子上](/base-ui/getting-started/overview/)的一套新组件,并给予您开箱即用的一些辅助功能支持。 我们尽最大努力使所有组件对屏幕阅读器友好,同时文档中也提供了无障碍访问的建议。
- **可访问性:** Joy UI 是建立在 [Base UI 的无样式基础组件和低级钩子上](/base-ui/getting-started/)的一套新组件,并给予您开箱即用的一些辅助功能支持。 我们尽最大努力使所有组件对屏幕阅读器友好,同时文档中也提供了无障碍访问的建议。

## Joy UI 与 Material UI 对比

Expand Down
2 changes: 1 addition & 1 deletion docs/data/joy/getting-started/overview/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Look for the [`package: joy-ui`](https://github.com/mui/material-ui/labels/packa

- **Ship faster:** Joy UI gives you pre-built components with a sleek and carefully designed look and feel, so you don't need design skills to ship beautiful UIs rapidly.
- **Extensive customization options:** you can customize each and every tiny piece of Joy UI's components to match your own unique design.
- **Accessibility in mind:** Joy UI components are built on top of [Base UI's unstyled components and low-level hooks](/base-ui/getting-started/overview/), giving you support for many accessibility features out of the box.
- **Accessibility in mind:** Joy UI components are built on top of [Base UI's unstyled components and low-level hooks](/base-ui/getting-started/), giving you support for many accessibility features out of the box.
We do our best to make all components screen reader-friendly, and also offer suggestions for optimizing accessibility throughout our documentation.

## Joy UI vs. Material UI
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ There are two main use cases for using them together:

Additionally, keep these in mind when using them together:

- Both of them use [MUI System](/system/getting-started/overview/) as their syle engine, which uses React context for theming.
- Both of them use [MUI System](/system/getting-started/) as their syle engine, which uses React context for theming.
- Joy UI requires wrapping your application with the `CssVarsProvider` component but you're able to import it from either @mui/joy or @mui/material.

## Case A: Joy UI in a Material UI project
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ There are two main use cases for using them together:

Additionally, keep these in mind when using them together:

- Both of them use [MUI System](/system/getting-started/overview/) as their syle engine, which uses React context for theming.
- Both of them use [MUI System](/system/getting-started/) as their syle engine, which uses React context for theming.
- Joy UI requires wrapping your application with the `CssVarsProvider` component but you're able to import it from either @mui/joy or @mui/material.

## Case A: Joy UI in a Material UI project
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Once Joy UI reaches component parity with Material UI, we recommend that you **_

Additionally, keep these in mind when using them together:

- Both of them use [MUI System](/system/getting-started/overview/) as their style engine, which uses React context for theming.
- Both of them use [MUI System](/system/getting-started/) as their style engine, which uses React context for theming.
- Theme scoping must be done on one of the libraries.

## Prerequisite
Expand Down
5 changes: 3 additions & 2 deletions docs/data/joy/pages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@ import pagesApi from './pagesApi';

const pages = [
{
pathname: '/joy-ui/getting-started',
pathname: '/joy-ui/getting-started-group',
title: 'Getting started',
icon: standardNavIcons.DescriptionIcon,
children: [
{ pathname: '/joy-ui/getting-started/overview' },
{ pathname: '/joy-ui/getting-started', title: 'Overview' },
{ pathname: '/joy-ui/getting-started/installation' },
{ pathname: '/joy-ui/getting-started/usage' },
{ pathname: '/joy-ui/getting-started/tutorial' },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ githubLabel: 'component: ClickAwayListener'
:::warning
Please refer to the [Click-Away Listener](/base-ui/react-click-away-listener/) component page in the Base UI docs for demos and details on usage.

Click-Away Listener is a part of the standalone [Base UI](/base-ui/getting-started/overview/) component library.
Click-Away Listener is a part of the standalone [Base UI](/base-ui/getting-started/) component library.
It is currently re-exported from `@mui/material` for your convenience, but it will be removed from this package in a future major version, after `@mui/base` gets a stable release.
:::
2 changes: 1 addition & 1 deletion docs/data/material/components/no-ssr/no-ssr.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ components: NoSsr
:::warning
Please refer to the [No-SSR](/base-ui/react-no-ssr/) component page in the Base UI docs for demos and details on usage.

No-SSR is a part of the standalone [Base UI](/base-ui/getting-started/overview/) component library.
No-SSR is a part of the standalone [Base UI](/base-ui/getting-started/) component library.
It is currently re-exported from `@mui/material` for your convenience, but it will be removed from this package in a future major version, after `@mui/base` gets a stable release.
:::
2 changes: 1 addition & 1 deletion docs/data/material/components/portal/portal.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ githubLabel: 'component: Portal'
:::warning
Please refer to the [Portal](/base-ui/react-portal/) component page in the Base UI docs for demos and details on usage.

Portal is a part of the standalone [Base UI](/base-ui/getting-started/overview/) component library.
Portal is a part of the standalone [Base UI](/base-ui/getting-started/) component library.
It is currently re-exported from `@mui/material` for your convenience, but it will be removed from this package in a future major version, after `@mui/base` gets a stable release.
:::
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ githubLabel: 'component: TextareaAutosize'
:::warning
Please refer to the [Textarea Autosize](/base-ui/react-textarea-autosize/) component page in the Base UI docs for demos and details on usage.

Textarea Autosize is a part of the standalone [Base UI](/base-ui/getting-started/overview/) component library.
Textarea Autosize is a part of the standalone [Base UI](/base-ui/getting-started/) component library.
It is currently re-exported from `@mui/material` for your convenience, but it will be removed from this package in a future major version, after `@mui/base` gets a stable release.
:::
Loading

0 comments on commit 9340efd

Please sign in to comment.