[docs] Polish to match standard #4344
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 tasks
oliviertassinari
commented
Nov 1, 2024
| @@ -94,14 +94,14 @@ Now you can start your Toolpad Studio application using one of the commands: | |||
| npm run toolpad-studio:dev | |||
| ``` | |||
|
|
|||
| ```bash yarn | |||
There was a problem hiding this comment.
Iterate on mui/mui-public#181.
|
|
||
| <p class="description">Learn how to install Toolpad Core in your local environment.</p> |
| </codeblock> | ||
|
|
||
| The Toolpad Core package has a peer dependency on `@mui/material` and `@mui/icons-material`. If you aren't using these already in your project, you can install them with: | ||
|
|
||
| <codeblock storageKey="package-manager"> | ||
|
|
||
| ```bash npm | ||
| npm install -S @mui/material @mui/icons-material @emotion/react @emotion/styled |
There was a problem hiding this comment.
Remove the -S. Isn't this the default https://docs.npmjs.com/cli/v10/commands/npm-install#save?
oliviertassinari
commented
Nov 1, 2024
Comment on lines
-7
to
+9
| ## Manual Installation | ||
| <p class="description">Learn how to install Toolpad Core in your local environment.</p> | ||
|
|
||
| ## Manual installation |
There was a problem hiding this comment.
We could use https://vale.sh/docs/topics/styles/#capitalization. But two challenges:
- There are valid uses of title cases when we reference components, e.g. https://mui.com/toolpad/core/react-app-provider/#next-js-app-router seems right, it's how Next.js labels it. It can be annoying to disable Vale rules
<!-- vale Style.Rule = NO -->. - Vale CI is broken, visible from [core] Fix Vale errors #4347.
apedroferreira
approved these changes
Nov 1, 2024
oliviertassinari
commented
Nov 1, 2024
| ## Dynamic Routes | ||
| ## Dynamic routes |
There was a problem hiding this comment.
@bharatkashyap Similar to #4306, I fixed a couple more to match https://www.notion.so/mui-org/Writing-style-guide-2a957a4168a54d47b14bae026d06a24b.
cc @samuelsycamore we are progressively getting to match the style guide everywhere 😄
This was referenced Nov 1, 2024
Merged
oliviertassinari
commented
Nov 1, 2024
| @@ -4,6 +4,6 @@ title: Toolpad Studio docs - Home | |||
|
|
|||
| # Toolpad Studio | |||
|
|
|||
| <p class="description">Toolpad Studio docs</p> | |||
| <p class="description">Toolpad Studio docs.</p> | |||
There was a problem hiding this comment.
We can enforce this in docs-infra: mui/material-ui#44292.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I noticed this from #4306 that fix the broken image reported in https://app.ahrefs.com/site-audit/3992793/data-explorer?columns=pageRating%2Curl%2ChttpCode%2CcontentType%2CincomingImage¤t=01-11-2024T025516&filterId=c7bd3d737800c382ec57c0adace75595&issueId=c0e87084-feaf-11e8-8c05-001e67ed4657&sorting=-pageRating (great to see this fixed beforehand!)