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] Refresh the home page #19430

Merged
merged 18 commits into from
Feb 1, 2020
Merged

Conversation

mbrookes
Copy link
Member

@mbrookes mbrookes added the docs Improvements or additions to the documentation label Jan 27, 2020
@mui-pr-bot
Copy link

mui-pr-bot commented Jan 27, 2020

Details of bundle changes.

Comparing: 5c84559...6ffab39

bundle Size Change Size Gzip Change Gzip
docs.landing ▲ +9.88 kB (+19.56% ) 60.4 kB ▲ +3.19 kB (+24.14% ) 16.4 kB
@material-ui/core -- 360 kB -- 98.7 kB
@material-ui/core[umd] -- 317 kB -- 91.9 kB
@material-ui/lab -- 185 kB -- 55.2 kB
@material-ui/styles -- 51.2 kB -- 15.4 kB
@material-ui/system -- 14.8 kB -- 4.07 kB
Alert -- 83.8 kB -- 26.3 kB
AlertTitle -- 64.2 kB -- 20.2 kB
AppBar -- 63.9 kB -- 20 kB
Autocomplete -- 132 kB -- 41.3 kB
Avatar -- 65.2 kB -- 20.6 kB
AvatarGroup -- 62.3 kB -- 19.6 kB
Backdrop -- 67.9 kB -- 21 kB
Badge -- 65.3 kB -- 20.4 kB
BottomNavigation -- 62.4 kB -- 19.6 kB
BottomNavigationAction -- 75.6 kB -- 23.9 kB
Box -- 70.9 kB -- 21.6 kB
Breadcrumbs -- 67.8 kB -- 21.3 kB
Button -- 79.8 kB -- 24.5 kB
ButtonBase -- 74 kB -- 23.3 kB
ButtonGroup -- 83.3 kB -- 25.5 kB
Card -- 62.9 kB -- 19.7 kB
CardActionArea -- 75.1 kB -- 23.7 kB
CardActions -- 62 kB -- 19.5 kB
CardContent -- 62 kB -- 19.4 kB
CardHeader -- 65.1 kB -- 20.5 kB
CardMedia -- 62.3 kB -- 19.6 kB
Checkbox -- 83 kB -- 26.3 kB
Chip -- 82.6 kB -- 25.4 kB
CircularProgress -- 64.1 kB -- 20.3 kB
ClickAwayListener -- 3.91 kB -- 1.55 kB
Collapse -- 68 kB -- 21.1 kB
colorManipulator -- 3.88 kB -- 1.52 kB
Container -- 63.3 kB -- 19.8 kB
CssBaseline -- 57.5 kB -- 18.1 kB
Dialog -- 83.1 kB -- 25.9 kB
DialogActions -- 62.1 kB -- 19.5 kB
DialogContent -- 62.2 kB -- 19.5 kB
DialogContentText -- 64 kB -- 20.2 kB
DialogTitle -- 64.3 kB -- 20.2 kB
Divider -- 62.6 kB -- 19.7 kB
docs.main -- 595 kB -- 194 kB
Drawer -- 84.8 kB -- 25.8 kB
ExpansionPanel -- 72.3 kB -- 22.7 kB
ExpansionPanelActions -- 62.1 kB -- 19.5 kB
ExpansionPanelDetails -- 61.9 kB -- 19.4 kB
ExpansionPanelSummary -- 78.2 kB -- 24.7 kB
Fab -- 76.9 kB -- 24 kB
Fade -- 23.4 kB -- 7.98 kB
FilledInput -- 73.6 kB -- 22.9 kB
FormControl -- 64.4 kB -- 20.1 kB
FormControlLabel -- 65.5 kB -- 20.6 kB
FormGroup -- 62 kB -- 19.5 kB
FormHelperText -- 63.3 kB -- 19.9 kB
FormLabel -- 63.5 kB -- 19.7 kB
Grid -- 65.1 kB -- 20.4 kB
GridList -- 62.5 kB -- 19.7 kB
GridListTile -- 63.7 kB -- 20 kB
GridListTileBar -- 63.2 kB -- 19.8 kB
Grow -- 24 kB -- 8.19 kB
Hidden -- 66 kB -- 20.7 kB
Icon -- 62.8 kB -- 19.7 kB
IconButton -- 76.2 kB -- 23.8 kB
Input -- 72.5 kB -- 22.7 kB
InputAdornment -- 65.1 kB -- 20.5 kB
InputBase -- 70.6 kB -- 22.2 kB
InputLabel -- 65.3 kB -- 20.2 kB
LinearProgress -- 65.3 kB -- 20.4 kB
Link -- 66.6 kB -- 21.1 kB
List -- 62.4 kB -- 19.5 kB
ListItem -- 77.2 kB -- 24.2 kB
ListItemAvatar -- 62.1 kB -- 19.5 kB
ListItemIcon -- 62.2 kB -- 19.5 kB
ListItemSecondaryAction -- 62 kB -- 19.5 kB
ListItemText -- 65 kB -- 20.4 kB
ListSubheader -- 62.8 kB -- 19.8 kB
Menu -- 88.8 kB -- 27.4 kB
MenuItem -- 78.2 kB -- 24.5 kB
MenuList -- 66 kB -- 20.7 kB
MobileStepper -- 67.8 kB -- 21.3 kB
Modal -- 14.5 kB -- 5.05 kB
NativeSelect -- 76.9 kB -- 24.3 kB
NoSsr -- 2.19 kB -- 1.04 kB
OutlinedInput -- 74.6 kB -- 23.2 kB
Paper -- 62.4 kB -- 19.5 kB
Popover -- 83.1 kB -- 25.8 kB
Popper -- 28.8 kB -- 10.3 kB
Portal -- 2.92 kB -- 1.3 kB
Radio -- 84.1 kB -- 26.5 kB
RadioGroup -- 64.5 kB -- 20 kB
Rating -- 70.5 kB -- 22.7 kB
RootRef -- 4.24 kB -- 1.64 kB
Select -- 116 kB -- 34.6 kB
Skeleton -- 62.9 kB -- 19.9 kB
Slide -- 25.5 kB -- 8.71 kB
Slider -- 76.6 kB -- 24.3 kB
Snackbar -- 75.4 kB -- 23.6 kB
SnackbarContent -- 63.5 kB -- 20 kB
SpeedDial -- 86.3 kB -- 27.2 kB
SpeedDialAction -- 118 kB -- 37.5 kB
SpeedDialIcon -- 64.6 kB -- 20.3 kB
Step -- 62.7 kB -- 19.7 kB
StepButton -- 82.4 kB -- 26.1 kB
StepConnector -- 62.7 kB -- 19.8 kB
StepContent -- 69.2 kB -- 21.7 kB
StepIcon -- 64.6 kB -- 20.2 kB
StepLabel -- 68.6 kB -- 21.7 kB
Stepper -- 64.9 kB -- 20.5 kB
styles/createMuiTheme -- 16.5 kB -- 5.81 kB
SvgIcon -- 63 kB -- 19.7 kB
SwipeableDrawer -- 92.3 kB -- 28.9 kB
Switch -- 82.2 kB -- 25.9 kB
Tab -- 76.4 kB -- 24.2 kB
Table -- 62.6 kB -- 19.7 kB
TableBody -- 62.1 kB -- 19.5 kB
TableCell -- 64 kB -- 20.2 kB
TableContainer -- 62 kB -- 19.4 kB
TableFooter -- 62.1 kB -- 19.5 kB
TableHead -- 62.1 kB -- 19.5 kB
TablePagination -- 143 kB -- 41.9 kB
TableRow -- 62.5 kB -- 19.6 kB
TableSortLabel -- 77.5 kB -- 24.4 kB
Tabs -- 85.7 kB -- 27.2 kB
TextareaAutosize -- 5.12 kB -- 2.14 kB
TextField -- 125 kB -- 36.6 kB
ToggleButton -- 76.2 kB -- 24.1 kB
ToggleButtonGroup -- 63.2 kB -- 19.9 kB
Toolbar -- 62.3 kB -- 19.6 kB
Tooltip -- 102 kB -- 32.3 kB
TreeItem -- 74 kB -- 23.4 kB
TreeView -- 66.7 kB -- 21 kB
Typography -- 63.7 kB -- 20 kB
useAutocomplete -- 14.6 kB -- 5.29 kB
useMediaQuery -- 2.51 kB -- 1.06 kB
Zoom -- 23.5 kB -- 8.1 kB

Generated by 🚫 dangerJS against 6ffab39

@mbrookes mbrookes marked this pull request as ready for review January 27, 2020 20:21
Copy link
Member

@eps1lon eps1lon left a comment

Choose a reason for hiding this comment

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

Looks great so far. A couple of remarks regarding various issues

  • move HomeQuote into HomeQuotes. These are coupled anyway and the folder is already pretty big. I don't think we're still dogmatic about one-component-per-file, are we?
  • there's too much unused space on the "first page". If we tighten the red circles slightly we should be able to make install and getting started visible on the landing page:
    mui-unused
  • link the tweets. Does not have to actually embedd them. But I don't know these people. I should be able to find out more about the quotes with a single click.

@oliviertassinari
Copy link
Member

oliviertassinari commented Jan 27, 2020

link the tweets

I had the same thought, it will be awesome once we have this 💯:+1:.
Here is the list of praise we have been collecting over the last few months https://trello.com/c/wNpa6A4G/2205-what-our-users-say-%F0%9F%A6%9C that Matt used.

@mbrookes
Copy link
Member Author

mbrookes commented Jan 27, 2020

Thanks for the initial review.

I don't think we're still dogmatic about one-component-per-file, are we?

You're right, I can't see it mattering for internal docs component, so I've merged them as suggested; but it sounds like there may also be an opportunity to introduce a hierarchy to the modules folder, rather than depending on a file naming convention in a flat directory structure.

there's too much unused space on the "first page".

That's a difficult balancing act. White-space is a good thing in design, and the large top and bottom margin help keep the white-space proportional to a wide left and right margin. That said, there may be some scope to trim it down a bit.

Another possibility is finding a new home for the GitHub and Twitter counters, and possibly also "quickWord", which have always seemed a bit lost in their current position. Perhaps the footer would be better suited for the counters at least.

link the tweets.

The Twitter examples in the Trello card were 50:50 (for a very small sample size). I wasn't sure if users would care that much when browsing the homepage. There is also an argument that sending first time visitors to your home page off to a source of distraction is not a good idea.

I've added links in any case so that we can judge the tradeoff.

@eps1lon
Copy link
Member

eps1lon commented Jan 27, 2020

About the tweets:
Totally understand the considerations. It was just my first instinct to click on them. I guess this is a good opportunity to use target="_blank"

About whitespace:
Also agree here. It was just that wit using one a 24 inch, 16:9 monitor, the install instructions were barely visible. Having them visible above the fold while sacrificing a bit of whitespace seemed reasonable. But then again: What is the most common screen real estate for first time visitors? And if it matches mine: Is having a barely visible 2nd paragraph good enough to get attention?

it sounds like there may also be an opportunity to introduce a hierarchy to the modules folder

Definitely. It is already at point where I feel like we have too much files in the same folder. Since the two mentioned files were relatively small, it seemed like the better idea to squash them (should be around 700 lines) instead of introducing hierarchy.

@mbrookes
Copy link
Member Author

I guess this is a good opportunity to use target="_blank"

Sounds like we're on the same page (pun intended 😉)

using one a 24 inch, 16:9 monitor, the install instructions were barely visible.

Same on my MBP. I hope the subtle adjustment strikes a good balance?

It is already at point where I feel like we have too much files in the same folder.

Agreed. Let's park that for a follow-up PR – I have merged the two related components into one file in any case.

Copy link
Member

@oliviertassinari oliviertassinari left a comment

Choose a reason for hiding this comment

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

The random+event on the quotes display is pretty smart! I love the changes :)

docs/src/modules/components/HomeQuotes.js Outdated Show resolved Hide resolved
docs/src/modules/components/HomeQuotes.js Show resolved Hide resolved
docs/static/logo.svg Show resolved Hide resolved
Matt and others added 2 commits January 28, 2020 21:18
Co-Authored-By: Olivier Tassinari <olivier.tassinari@gmail.com>
Co-Authored-By: Olivier Tassinari <olivier.tassinari@gmail.com>
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants