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] Add full page examples #10986

Closed
xeoncross opened this issue Apr 10, 2018 · 5 comments
Closed

[docs] Add full page examples #10986

xeoncross opened this issue Apr 10, 2018 · 5 comments
Labels
docs Improvements or additions to the documentation
Milestone

Comments

@xeoncross
Copy link

xeoncross commented Apr 10, 2018

I created a sample app shell with a responsive left-drawer and content cards based on the component demos you have provided.

I am sharing a link here as this might be a good demo for the documentation (you're welcome to fork it as it is mostly MUI code anyway).

https://codesandbox.io/s/3x24zvxr1

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Apr 11, 2018
@oliviertassinari oliviertassinari changed the title Example v1 Application [docs] Add full page examples Apr 11, 2018
@oliviertassinari
Copy link
Member

oliviertassinari commented Apr 11, 2018

@xeoncross Thanks for sharing this app shell.
In the future, I think that it would be great to add full page example of different layout. It would be the opportunity of demonstrating how to wire all the lower components together and to all people to quickly start. Some benchmarking:

@yzorg
Copy link

yzorg commented May 1, 2018

I also tried to create a sample on CS: minimum boilerplate required to use dark theme. Would you like to include it? I started with Olivier's, but I was inspired by Xeon's so I updated my React & ReactDOM to latest (16.3.2).

https://codesandbox.io/s/4jxkqzjw24

@oliviertassinari
Copy link
Member

@yzorg Thanks for the resource. We will see how to leverage it once we start working on this issue.

@Klynger
Copy link
Contributor

Klynger commented Aug 21, 2018

What about full applications, with routes, some own components, lazy loader for routes, internationalization and other things. I have a sort of template (this one) and I would like to add in your docs. Is not finished yet, I need to make some adjustments, even to the code (add a lint and other things), but it is responsive and I think that looks nice. I'm open to new ideas to make it better. Do you guys think that it is a good idea adding this kind of full apps to your docs?
deepinscreenshot_select-area_20180821114302
deepinscreenshot_select-area_20180821114333

@mbrookes
Copy link
Member

No objection here, presuming they're well documented (what technologies, what opinionated features etc.), and are maintained on an ongoing basis.

It could go in related projects.

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

No branches or pull requests

5 participants