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

Demos in the documentation are too specific #11540

Closed
2 tasks done
akullpp opened this issue May 22, 2018 · 1 comment
Closed
2 tasks done

Demos in the documentation are too specific #11540

akullpp opened this issue May 22, 2018 · 1 comment

Comments

@akullpp
Copy link

akullpp commented May 22, 2018

  • This is a v1.x issue (v0.x is no longer maintained).
  • I have searched the issues of this repository and believe that this is not a duplicate.

Expected Behavior

Provide a minimal unopinionated documentation of the components which you can ideally copy/paste to your application.

Current Behavior

Take a look at the MiniDrawer example, nowhere is an implementation to be found what is actually passed to the component in order to reproduce the demo. The properties are not trivial as they contain functions, e.g. theme. Even if you try to simplify it by removing the HOC and use a default theme with:

const theme = createMuiTheme()
const classes = styles(theme)

you will not get a usable implementation.

Another thing is the usage of classNames which is rather strong assuption for a documentation I think.

@akullpp akullpp changed the title Documentation too specific Demos in the documentation are too specific May 22, 2018
@oliviertassinari
Copy link
Member

@akullpp The examples try to demonstrate how to use the component in a page. We have tried to keep them as simple as possible. Feel free to submit a pull request if you find a way to simplify them. We also plan on adding full page examples #10986

Another thing is the usage of classNames which is rather a strong assumption for a documentation I think.

Is it? https://npm-stat.com/charts.html?package=react-dom&package=classnames

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants