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] Lacks documentation #195

Closed
owais opened this issue Jan 4, 2015 · 4 comments
Closed

[docs] Lacks documentation #195

owais opened this issue Jan 4, 2015 · 4 comments
Labels
docs Improvements or additions to the documentation

Comments

@owais
Copy link

owais commented Jan 4, 2015

This is amazing. React + Material === Bliss.

I was trying this out but the project really lacks documentation especially on the CSS side. I whipped something up by looking at the example and found out that there are things like AppCanvas, AppBar and what not that are not documented. I really believe this project can become really popular given it gets proper documentation like bootstrap or foundation.

P.S. A great start. My favourite github discovery of the month :)

@hai-cea
Copy link
Member

hai-cea commented Jan 18, 2015

Thanks @owais - Documentation is certainly something we're committed to. As for AppCanvas and AppBar, these were one of the first components we wrote and so I believe them to be a bit rough and may change as we harden them up. The same goes for the css.

@LongLiveCHIEF
Copy link

Still though, at least a mention of them in the docs would be helpful. Perhaps a section on "undocumented" components? Just referring people to the source? That would have saved me hours.

@dozoisch
Copy link

dozoisch commented Jun 5, 2015

@LongLiveCHIEF Oh I would love a "undocumented components" section too! That would be really useful.. instead of having to go look in https://github.com/callemall/material-ui/blob/master/src/index.js directly!

@hai-cea hai-cea changed the title Lacks documentation [docs] Lacks documentation Jun 18, 2015
@jkruder jkruder added the docs Improvements or additions to the documentation label Jul 8, 2015
@shaurya947
Copy link
Contributor

I think we're at a good point now where most components have adequate documentation, and wherever it is lacking, people have opened issues and proposed PRs. So I'll be closing this for now.

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

7 participants