Skip to content

Commit

Permalink
Tweaks to the text
Browse files Browse the repository at this point in the history
  • Loading branch information
@zanivan
zanivan committed Sep 10, 2024
1 parent dd74af9 commit b01d202
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/data/material/getting-started/faq/faq.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ If you are getting the error: `TypeError: Cannot convert a Symbol value to a str

## How can I contribute to the free templates?

Check warning on line 264 in docs/data/material/getting-started/faq/faq.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.FirstPerson] Avoid first-person pronouns such as ' I '.

Raw Output:
{"message": "[Google.FirstPerson] Avoid first-person pronouns such as ' I '.", "location": {"path": "docs/data/material/getting-started/faq/faq.md", "range": {"start": {"line": 264, "column": 11}}}, "severity": "WARNING"}

The templates are built using the shared theme. Below are the structure to create a new template:
The templates are built using a [shared theme](https://github.com/mui/material-ui/tree/v6.0.2/docs/data/material/getting-started/templates/shared-theme). Below are the structure to create a new template:

### Template page

Expand Down Expand Up @@ -294,7 +294,7 @@ Then create a template file at `docs/data/material/getting-started/templates/<na

The template must use `AppTheme` from `../shared-theme/AppTheme` to ensure a consistent look and feel across all templates.

If the template contains custom themed components, for example the dashboard template has MUI X themed components, pass the themed components to the `AppTheme`'s `themedComponents` prop:
If the template includes custom-themed components, such as the dashboard template with MUI X themed components, pass them to the `AppTheme`'s `themedComponents` prop:

Check warning on line 297 in docs/data/material/getting-started/faq/faq.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[MUI.NoCompanyName] We avoid referencing the company name 'MUI X'. Instead you can reference a product or the team.

Raw Output:
{"message": "[MUI.NoCompanyName] We avoid referencing the company name 'MUI X'. Instead you can reference a product or the team.", "location": {"path": "docs/data/material/getting-started/faq/faq.md", "range": {"start": {"line": 297, "column": 88}}}, "severity": "WARNING"}

Check failure on line 297 in docs/data/material/getting-started/faq/faq.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[MUI.MuiBrandName] Use a non-breaking space (option+space on Mac, Alt+0160 on Windows or AltGr+Space on Linux, instead of space) for brand name ('MUI X' instead of 'MUI X')

Raw Output:
{"message": "[MUI.MuiBrandName] Use a non-breaking space (option+space on Mac, Alt+0160 on Windows or AltGr+Space on Linux, instead of space) for brand name ('MUI X' instead of 'MUI X')", "location": {"path": "docs/data/material/getting-started/faq/faq.md", "range": {"start": {"line": 297, "column": 88}}}, "severity": "ERROR"}

```js
import AppTheme from '../shared-theme/AppTheme';
Expand Down Expand Up @@ -334,7 +334,7 @@ For example, the dashboard template has a fixed header that needs to be accounte
>
```

This will make the `AppBar` stay below the `TemplateFrame` in a preview mode but stick to the top in the Code Sandbox and Stackblitz.
This will make the `AppBar` stay below the `TemplateFrame` in a preview mode but stick to the top in the CodeSandbox and Stackblitz.

Check warning on line 337 in docs/data/material/getting-started/faq/faq.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/data/material/getting-started/faq/faq.md", "range": {"start": {"line": 337, "column": 6}}}, "severity": "WARNING"}

## [legacy] I have several instances of styles on the page

Expand Down

0 comments on commit b01d202

Please sign in to comment.