Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Handle a few docs-feedback #36977

Merged
merged 2 commits into from
Apr 27, 2023

Conversation

oliviertassinari
Copy link
Member

No description provided.

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Apr 23, 2023
Comment on lines -67 to -75
<!-- TODO: revert this once it is migrated to v5
- [Material Sense](https://github.com/alexanmtz/material-sense):

- ![stars](https://img.shields.io/github/stars/alexanmtz/material-sense.svg?style=social&label=Star)
- Graph using recharts
- React Router included with a navigation example
- A docker container with an Nginx server for production build
- Created with Create React App
-->
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's abandoned now.

@@ -53,7 +53,12 @@ If you want to start with a more complete and real-world example, you could take
- All PWA features included (SW, Notifications, deferred installation prompt and more)
- Optimized and scalable performance (all ~100 points on Lighthouse)

<!-- TODO: revert this once it is migrated to v5
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They migrated a year ago.

@@ -27,7 +27,7 @@ const appList = [
description:
'QuintoAndar is a company that uses technology and ' +
'design to simplify the rental of residential real estate.',
image: 'quintoandar.png',
image: 'quintoandar.jpg',
Copy link
Member Author

@oliviertassinari oliviertassinari Apr 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was looking like crap, so redo a few screenshots, following a process close to https://www.notion.so/mui-org/Store-Screenshots-for-product-7a4cf2df5cb94389ab6adc80b6aeb054. We would need to retake all the screenshots, but since we might rework from scratch this page, I only did the first two.

https://mui.com/material-ui/discover-more/showcase/ burns my eye 🙃

Comment on lines +104 to +105
width="600"
height="450"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix layout shift when loading

@@ -54,7 +54,7 @@ export default function Showcase() {
};

return (
<Box sx={{ flexGrow: 1 }}>
<Box sx={{ flexGrow: 1, mx: [2, 0] }}>
Copy link
Member Author

@oliviertassinari oliviertassinari Apr 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was broken on mobile, I think it was sending a red flag for designers that are considering using Material UI

Screenshot 2023-04-24 at 00 19 38

@@ -45,7 +45,7 @@ const sortFunctions = {
};

export default function Showcase() {
const [sortFunctionName, setSortFunctionName] = React.useState('dateAdded');
const [sortFunctionName, setSortFunctionName] = React.useState('similarWebVisits');
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The traffic makes a lot more sense IMHO, it sends trust.

Comment on lines +60 to +62
## Admin frameworks

- [React Admin](https://github.com/marmelab/react-admin): A frontend Framework for building data-driven applications running in the browser on top of REST/GraphQL APIs.
Copy link
Member Author

@oliviertassinari oliviertassinari Apr 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With https://mui.zendesk.com/agent/tickets/7593 we could add refine too.

@@ -32,7 +32,7 @@ From now on, the `Grid` v1 and `Grid` v2 refer to the import as:

```js
import Grid from '@mui/material/Grid'; // Grid version 1
import Grid2 from '@mui/material/Unstable_Grid2'; // Grid version 2
import Grid from '@mui/material/Unstable_Grid2'; // Grid version 2
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency with the text above. Reported in https://mui-org.slack.com/archives/C041SDSF32L/p1681137941293499.

![npm downloads](https://img.shields.io/npm/dm/material-ui-confirm.svg)

This package provides dialogs for confirming user actions without writing boilerplate code.
The package [`material-ui-confirm`](https://github.com/jonatanklosko/material-ui-confirm/) provides dialogs for confirming user actions without writing boilerplate code.
Copy link
Member Author

@oliviertassinari oliviertassinari Apr 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have seen at least 3 people complain about this. It's hard to find the source. Proof:

I think that we miss some kind of process for this to be prioritized, it seems to be a clear quick-win.

@oliviertassinari oliviertassinari added the enhancement This is not a bug, nor a new feature label Apr 23, 2023
@@ -41,7 +41,7 @@ It's possible to customize the control icons.

## Pagination ranges

You can specify how many digits to display either side of current page with the `siblingRange` prop, and adjacent to the start and end page number with the `boundaryRange` prop.
You can specify how many digits to display either side of current page with the `siblingCount` prop, and adjacent to the start and end page number with the `boundaryCount` prop.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@oliviertassinari oliviertassinari merged commit 7d1e34e into mui:master Apr 27, 2023
@oliviertassinari oliviertassinari deleted the update-related-projects branch April 27, 2023 23:10
binh1298 pushed a commit to binh1298/material-ui that referenced this pull request May 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation enhancement This is not a bug, nor a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants