Material-ui: Link to Usage from Installation doc

Created on 27 Mar 2019  路  10Comments  路  Source: mui-org/material-ui

Just a suggestion on how to make the first-time documentation experience a little more smooth.

The Get Started button on the homepage links to the Installation doc.

When the viewport is slightly narrow, the nav on the left is hidden.

Screen Shot 2019-03-27 at 10 56 28 AM

To complete the getting started experience, it'd be helpful to include a Next steps section at the bottom of the Installation doc, that links to the Usage.

docs important

Most helpful comment

@oliviertassinari I'll take on this task if no one else is!

All 10 comments

I can submit this PR. Just running the idea by you all first.

@kaycebasques It's an excellent ideal. I have a task for it in my backlog. I have never found the time to do it. It's something we can generalize to all the pages of the documentation. A < previous | next > links with a preview of the linked pages will improve the navigation :). We would love to review your pull request <3.

@kaycebasques Did you had the chance to move forward on this problem?

I like styled-components solution of the problem:

Capture d鈥檈虂cran 2019-04-20 a虁 00 50 42
https://www.styled-components.com/docs/api#deprecated-innerref-prop

@oliviertassinari I'll take on this task if no one else is!

@jztang activePage & pages from PageContext will be useful to you in determining the next page. See: https://github.com/mui-org/material-ui/blob/9634f2954adc512e32d785666932248f2716577d/docs/src/modules/components/AppDrawer.js#L98 & https://github.com/mui-org/material-ui/blob/9634f2954adc512e32d785666932248f2716577d/docs/src/modules/components/MarkdownDocsContents.js#L14 for example.

activePage is the path to the current page, pages is the docs page tree structure as an object.

My plan was to just manually put links in each docs page one at a time, but now I realize that solution isn't particularly efficient, and it would be much better to find neighboring pages via the tree. 馃槀

I assume that means I only need to make a change in the file that generates the layout of each docs page. However, I'm not sure where to find that file in the codebase - could you point me in the right direction?

Sorry, I'm going to have to unclaim this issue. I didn't realize that it was out of the scope of my knowledge until now. 馃槬

No worries, there are plenty of good first issues you could tackle if you would still like to contribute.

Was this page helpful?
0 / 5 - 0 ratings