Skip to content

Commit

Permalink
[docs-infra] Fix Stack Overflow breaking space
Browse files Browse the repository at this point in the history
  • Loading branch information
oliviertassinari committed Feb 25, 2024
1 parent ea9fd41 commit 364b723
Show file tree
Hide file tree
Showing 26 changed files with 54 additions and 49 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/support-stackoverflow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ jobs:
# Comment to post on issues marked as support requests. Add a link
# to a support page, or set to `false` to disable
issue-comment: |
👋 Thanks for using MUI Core!
👋 Thanks for using our open-source projects!
We use GitHub issues exclusively as a bug and feature requests tracker, however,
this issue appears to be a support request.
For support, please check out https://mui.com/getting-started/support/. Thanks!
For support with Material UI please check out https://mui.com/material-ui/getting-started/support/. Thanks!
If you have a question on Stack Overflow, you are welcome to link to it here, it might help others.
If you have a question on Stack Overflow, you are welcome to link to it here, it might help others.
If your issue is subsequently confirmed as a bug, and the report follows the issue template, it can be reopened.
close-issue: true
lock-issue: false
14 changes: 7 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ This release was mostly about 🐛 bug fixes and 📚 documentation improvements
- [typescript-to-proptypes] Support using `Omit` on types with conditional properties (#41033) @flaviendelangle
- [website] Match chart component names @oliviertassinari
- [website] Add Marblism diamond sponsor (#41097) @rluzists1
- [website] Add overall improvements to the Material UI page (#41075) @danilo-leal
- [website] Add overall improvements to the Material UI page (#41075) @danilo-leal
- [website] Fix responsive breakpoints @oliviertassinari
- [website] Fix overloading of footer JS files @oliviertassinari
- [website] Improve the footer's chip contrast (#41209) @danilo-leal
Expand Down Expand Up @@ -2577,7 +2577,7 @@ A big thanks to the 25 contributors who made this release possible. Here are som
- &#8203;<!-- 39 -->[core] Add priority support issue template (#37671) @DanailH
- &#8203;<!-- 03 -->[website] Update roadmap page (#37587) @cherniavskii
- &#8203;<!-- 02 -->[website] Add CSP to limit iframes to self @oliviertassinari
- &#8203;<!-- 01 -->[website] Link mui-x Stack Overflow in footer link (#37509) @richbustos
- &#8203;<!-- 01 -->[website] Link mui-x Stack Overflow in footer link (#37509) @richbustos

All contributors of this release in alphabetical order: @abhinavkmrru, @alexfauquette, @bencevoros, @cherniavskii, @danilo-leal, @DiegoAndai, @DIWAKARKASHYAP, @flaviendelangle, @gitstart, @hbjORbj, @ivp-dev, @Janpot, @michaldudak, @mnajdova, @oliviertassinari, @Primajin, @PunitSoniME, @richbustos, @romgrk, @sai6855, @sernstberger, @siriwatknp, @SuperKXT, @vinayr, @ZeeshanTamboli

Expand Down Expand Up @@ -7666,7 +7666,7 @@ A big thanks to the 16 contributors who made this release possible. Here are som
- &#8203;<!-- 19 -->[docs] Sync translations with Crowdin (#30067) @l10nbot
- &#8203;<!-- 18 -->[docs] Fix link on "Custom variables" section in the Theming page #30100 @danilo-leal
- &#8203;<!-- 17 -->[docs] Fix justifyContent option in the Grid interactive demo (#30117) @danilo-leal
- &#8203;<!-- 16 -->[docs] Add tip to help access the docs of a previous version when finding answers in Stack Overflow (#30101) @danilo-leal
- &#8203;<!-- 16 -->[docs] Add tip to help access the docs of a previous version when finding answers in Stack Overflow (#30101) @danilo-leal
- &#8203;<!-- 15 -->[docs] Fix import example inside Unstyled Backdrop section (#30098) @TheodosiouTh
- &#8203;<!-- 01 -->[website] Column pinning and Tree data are out (#30136) @oliviertassinari
- &#8203;<!-- 07 -->[survey] Remove survey promotion items (#30122) @danilo-leal
Expand Down Expand Up @@ -7747,7 +7747,7 @@ A big thanks to the 25 contributors who made this release possible. Here are som
- &#8203;<!-- 21 -->[docs] Update nextjs-typescript-example (#29974) @huydhoang
- &#8203;<!-- 20 -->[docs] Add missing global state classes to API docs generator (#29945) @michaldudak
- &#8203;<!-- 19 -->[docs] Fix benchmarks folder link (#29981) @fourjr
- &#8203;<!-- 18 -->[docs] Improve wording in Stack Overflow section of support page (#29956) @ronwarner
- &#8203;<!-- 18 -->[docs] Improve wording in Stack Overflow section of support page (#29956) @ronwarner
- &#8203;<!-- 17 -->[docs] Remove Black Friday sale notification (#29936) @mbrookes
- &#8203;<!-- 16 -->[examples] Fix typos in the Remix example (#30071) @MichaelDeBoey
- &#8203;<!-- 15 -->[examples] Add Remix example (#29952) @mnajdova
Expand All @@ -7760,7 +7760,7 @@ A big thanks to the 25 contributors who made this release possible. Here are som
### Core

- &#8203;<!-- 31 -->[core] Batch small changes (#30042) @oliviertassinari
- &#8203;<!-- 28 -->[core] Transition to a new Stack Overflow tag (#29967) @oliviertassinari
- &#8203;<!-- 28 -->[core] Transition to a new Stack Overflow tag (#29967) @oliviertassinari

All contributors of this release in alphabetical order: @chao813, @daniel-sachs, @danilo-leal, @Domino987, @eduardomcv, @flaviendelangle, @fourjr, @genzyy, @hbjORbj, @huydhoang, @jayeclark, @jonathanrtuck, @kkorach, @l10nbot, @mbrookes, @MichaelDeBoey, @michaldudak, @mnajdova, @oliviertassinari, @ronwarner, @Semigradsky, @siriwatknp, @tasugi, @ThewBear, @ZeeshanTamboli

Expand Down Expand Up @@ -9036,7 +9036,7 @@ A big thanks to the 15 contributors who made this release possible. Here are som
- &#8203;<!-- 37 -->[website] Add spicefactory as gold sponsor @oliviertassinari
- &#8203;<!-- 30 -->[website] Homepage rebranding (#27488) @siriwatknp
- &#8203;<!-- 24 -->[website] Add Flavien to team and about pages (#27575) @flaviendelangle
- &#8203;<!-- 17 -->[website] Add Ryan to Community contributors for Stack Overflow contributions (#27529) @ryancogswell
- &#8203;<!-- 17 -->[website] Add Ryan to Community contributors for Stack Overflow contributions (#27529) @ryancogswell
- &#8203;<!-- 02 -->[website] Add references section to home (#27444) @siriwatknp

### Core
Expand Down Expand Up @@ -11451,7 +11451,7 @@ A big thanks to the 30 contributors who made this release possible. Here are som
#### Breaking changes

- &#8203;<!-- 91 -->[types] Rename the exported `Omit` type in `@material-ui/types`. (#24795) @petyosi
The module is now called `DistributiveOmit`. The change removes the confusion with the built-in `Omit` helper introduced in TypeScript v3.5. The built-in `Omit`, while similar, is non-distributive. This leads to differences when applied to union types. [See this Stack Overflow answer for further details](https://stackoverflow.com/a/57103940/1009797).
The module is now called `DistributiveOmit`. The change removes the confusion with the built-in `Omit` helper introduced in TypeScript v3.5. The built-in `Omit`, while similar, is non-distributive. This leads to differences when applied to union types. [See this Stack Overflow answer for further details](https://stackoverflow.com/a/57103940/1009797).

```diff
-import { Omit } from '@material-ui/types';
Expand Down
6 changes: 3 additions & 3 deletions docs/data/base/getting-started/support/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ You have a few possible options to provide it:

- You can use a starter React template to build a reproduction case with [JavaScript](https://stackblitz.com/github/stackblitz/starters/tree/main/react) or [TypeScript](https://stackblitz.com/github/stackblitz/starters/tree/main/react-ts).

## Stack Overflow
## Stack Overflow

We use Stack Overflow for how-to questions. Answers are crowdsourced from expert developers in the Base UI community as well as Base UI maintainers.
We use Stack Overflow for how-to questions. Answers are crowdsourced from expert developers in the Base UI community as well as Base UI maintainers.

You can search through existing questions and answers to see if someone has asked a similar question using the [base-ui tags](https://stackoverflow.com/questions/tagged/base-ui):

Expand Down Expand Up @@ -84,7 +84,7 @@ Our tools are used by thousands of developers and teams all around the world, ma
You can join Discord to engage in lively discussions, share your projects, and interact with developers just like you from all around the world. We'd love for you to join us!

:::warning
How-to questions are not accepted on Discord, they should be asked on [Stack Overflow](#stack-overflow).
How-to questions are not accepted on Discord, they should be asked on [Stack Overflow](#stack-overflow).
:::

## Custom work
Expand Down
8 changes: 4 additions & 4 deletions docs/data/joy/components/box/box.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ components: Box
githubLabel: 'component: Box'
---

<!-- This page's content is duplicated (with some product-specific details) across the Material UI, Joy UI, and MUI System docs. Any changes should be applied to all three pages at the same time. -->
<!-- This page's content is duplicated (with some product-specific details) across the Material UI, Joy UI, and MUI System docs. Any changes should be applied to all three pages at the same time. -->

# Box

Expand Down Expand Up @@ -36,16 +36,16 @@ The demo below replaces the `<div>` with a `<section>` element:

## Customization

### With MUI System props
### With MUI System props

As a CSS utility component, the Box supports all [MUI System properties](/system/properties/).
As a CSS utility component, the Box supports all [MUI System properties](/system/properties/).
You can use them as props directly on the component.

{{"demo": "BoxSystemProps.js", "defaultCodeOpen": true }}

### With the sx prop

Use the [`sx` prop](/system/getting-started/the-sx-prop/) to quickly customize any Box instance using a superset of CSS that has access to all the style functions and theme-aware properties exposed in the MUI System package.
Use the [`sx` prop](/system/getting-started/the-sx-prop/) to quickly customize any Box instance using a superset of CSS that has access to all the style functions and theme-aware properties exposed in the MUI System package.
The demo below shows how to apply colors from the theme using this prop:

{{"demo": "BoxSx.js", "defaultCodeOpen": true }}
Expand Down
6 changes: 3 additions & 3 deletions docs/data/joy/getting-started/support/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ You can browse the documentation, find an example close to your use case, and th

You can use a starter React template to build a reproduction case with [JavaScript](https://stackblitz.com/github/stackblitz/starters/tree/main/react) or [TypeScript](https://stackblitz.com/github/stackblitz/starters/tree/main/react-ts).

## Stack Overflow
## Stack Overflow

We use Stack Overflow for how-to questions. Answers are crowdsourced from expert developers in the Joy UI community as well as Joy UI maintainers.
We use Stack Overflow for how-to questions. Answers are crowdsourced from expert developers in the Joy UI community as well as Joy UI maintainers.

You can search through existing questions and answers to see if someone has asked a similar question using the [joy-ui tags](https://stackoverflow.com/questions/tagged/joy-ui):

Expand Down Expand Up @@ -89,7 +89,7 @@ Our tools are used by thousands of developers and teams all around the world, ma
You can join Discord to engage in lively discussions, share your projects, and interact with developers just like you from all around the world. We'd love for you to join us!

:::warning
How-to questions are not accepted on Discord, they should be asked on [Stack Overflow](#stack-overflow).
How-to questions are not accepted on Discord, they should be asked on [Stack Overflow](#stack-overflow).
:::

## Custom work
Expand Down
12 changes: 6 additions & 6 deletions docs/data/material/components/box/box.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ components: Box
githubLabel: 'component: Box'
---

<!-- This page's content is duplicated (with some product-specific details) across the Material UI, Joy UI, and MUI System docs. Any changes should be applied to all three pages at the same time. -->
<!-- This page's content is duplicated (with some product-specific details) across the Material UI, Joy UI, and MUI System docs. Any changes should be applied to all three pages at the same time. -->

# Box

Expand All @@ -16,11 +16,11 @@ githubLabel: 'component: Box'
## Introduction

The Box component is a generic container for grouping other components.
It's a fundamental building block when working with Material UI—you can think of it as a `<div>` with extra built-in features, like access to your app's theme and the [`sx` prop](/system/getting-started/the-sx-prop/).
It's a fundamental building block when working with Material UI—you can think of it as a `<div>` with extra built-in features, like access to your app's theme and the [`sx` prop](/system/getting-started/the-sx-prop/).

### Usage

The Box component differs from other containers available in Material UI in that its usage is intended to be multipurpose and open-ended, just like a `<div>`.
The Box component differs from other containers available in Material UI in that its usage is intended to be multipurpose and open-ended, just like a `<div>`.
Components like [Container](/material-ui/react-container/), [Stack](/material-ui/react-stack/) and [Paper](/material-ui/react-paper/), by contrast, feature usage-specific props that make them ideal for certain use cases: Container for main layout orientation, Stack for one-dimensional layouts, and Paper for elevated surfaces.

## Basics
Expand All @@ -36,16 +36,16 @@ The demo below replaces the `<div>` with a `<section>` element:

## Customization

### With MUI System props
### With MUI System props

As a CSS utility component, the Box supports all [MUI System properties](/system/properties/).
As a CSS utility component, the Box supports all [MUI System properties](/system/properties/).
You can use them as props directly on the component.

{{"demo": "BoxSystemProps.js", "defaultCodeOpen": true }}

### With the sx prop

Use the [`sx` prop](/system/getting-started/the-sx-prop/) to quickly customize any Box instance using a superset of CSS that has access to all the style functions and theme-aware properties exposed in the MUI System package.
Use the [`sx` prop](/system/getting-started/the-sx-prop/) to quickly customize any Box instance using a superset of CSS that has access to all the style functions and theme-aware properties exposed in the MUI System package.
The demo below shows how to apply colors from the theme using this prop:

{{"demo": "BoxSx.js", "defaultCodeOpen": true }}
Expand Down
2 changes: 1 addition & 1 deletion docs/data/material/getting-started/faq/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ There are many ways to support us:
Follow us on [X](https://twitter.com/MUI_hq), like and retweet the important news. Or just talk about us with your friends.
- **Give us feedback**. Tell us what is going well or where there is improvement opportunities. Please upvote (👍) the issues that you are the most interested in seeing solved.
- **Help new users**. You can answer questions on
[Stack Overflow](https://stackoverflow.com/questions/tagged/material-ui).
[Stack Overflow](https://stackoverflow.com/questions/tagged/material-ui).
- **Make changes happen**.
- Edit the documentation. At the bottom of every page, you can find an "Edit this page" button.
- Report bugs or missing features by [creating an issue](https://github.com/mui/material-ui/issues/new).
Expand Down
2 changes: 1 addition & 1 deletion docs/data/material/getting-started/overview/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ You can follow [this GitHub issue](https://github.com/mui/material-ui/issues/293
The [design kits](https://mui.com/design-kits/) streamline your workflow and boost consistency between designers and developers.
- **Trusted by thousands of organizations:** Material UI has the largest UI community in the React ecosystem.
It's almost as old as React itself—its history stretches back to 2014—and we're in this for the long haul.
You can count on the community's support for years to come (e.g. [Stack Overflow](https://insights.stackoverflow.com/trends?tags=material-ui)).
You can count on the community's support for years to come (e.g. [Stack Overflow](https://insights.stackoverflow.com/trends?tags=material-ui)).

### Material UI vs. Base UI

Expand Down
6 changes: 3 additions & 3 deletions docs/data/material/getting-started/support/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ You have a few possible options to provide it:

- You can use a starter React template to build a reproduction case with [JavaScript](https://stackblitz.com/github/stackblitz/starters/tree/main/react) or [TypeScript](https://stackblitz.com/github/stackblitz/starters/tree/main/react-ts).

## Stack Overflow
## Stack Overflow

We use Stack Overflow for how-to questions. Answers are crowdsourced from expert developers in the Material UI community as well as Material UI maintainers.
We use Stack Overflow for how-to questions. Answers are crowdsourced from expert developers in the Material UI community as well as Material UI maintainers.

You can search through existing questions and answers to see if someone has asked a similar question using the [material-ui tags](https://stackoverflow.com/questions/tagged/material-ui):

Expand Down Expand Up @@ -89,7 +89,7 @@ Our tools are used by thousands of developers and teams all around the world, ma
You can join Discord to engage in lively discussions, share your projects, and interact with developers just like you from all around the world. We'd love for you to join us!

:::warning
How-to questions are not accepted on Discord, they should be asked on [Stack Overflow](#stack-overflow).
How-to questions are not accepted on Discord, they should be asked on [Stack Overflow](#stack-overflow).
:::

## Custom work
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2008,7 +2008,7 @@ This change removes the confusion with the built-in `Omit` helper introduced in

The built-in `Omit`, while similar, is non-distributive.
This leads to differences when applied to union types.
[See this Stack Overflow answer for further details](https://stackoverflow.com/questions/57103834/typescript-omit-a-property-from-all-interfaces-in-a-union-but-keep-the-union-s/57103940#57103940).
[See this Stack Overflow answer for further details](https://stackoverflow.com/questions/57103834/typescript-omit-a-property-from-all-interfaces-in-a-union-but-keep-the-union-s/57103940#57103940).

```diff
-import { Omit } from '@mui/types';
Expand Down
2 changes: 1 addition & 1 deletion docs/data/system/components/box/box.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ components: Box
githubLabel: 'component: Box'
---

<!-- This page's content is duplicated (with some product-specific details) across the Material UI, Joy UI, and MUI System docs. Any changes should be applied to all three pages at the same time. -->
<!-- This page's content is duplicated (with some product-specific details) across the Material UI, Joy UI, and MUI System docs. Any changes should be applied to all three pages at the same time. -->

# Box

Expand Down
6 changes: 3 additions & 3 deletions docs/data/system/getting-started/support/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ You have a few possible options to provide it:

- You can use a starter React template to build a reproduction case with [JavaScript](https://stackblitz.com/github/stackblitz/starters/tree/main/react) or [TypeScript](https://stackblitz.com/github/stackblitz/starters/tree/main/react-ts).

## Stack Overflow
## Stack Overflow

We use Stack Overflow for how-to questions. Answers are crowdsourced from expert developers in the MUI System community as well as MUI System maintainers.
We use Stack Overflow for how-to questions. Answers are crowdsourced from expert developers in the MUI System community as well as MUI System maintainers.

You can search through existing questions and answers to see if someone has asked a similar question using the [mui-system tags](https://stackoverflow.com/questions/tagged/material-ui):

Expand Down Expand Up @@ -84,7 +84,7 @@ Our tools are used by thousands of developers and teams all around the world, ma
You can join Discord to engage in lively discussions, share your projects, and interact with developers just like you from all around the world. We'd love for you to join us!

:::warning
How-to questions are not accepted on Discord, they should be asked on [Stack Overflow](#stack-overflow).
How-to questions are not accepted on Discord, they should be asked on [Stack Overflow](#stack-overflow).
:::

## Custom work
Expand Down
Loading

0 comments on commit 364b723

Please sign in to comment.