Documentation is lacking

[HarelM]

Bug

Can't find proper info in current documentation.

What is the expected behavior?

No need to go to stack-overflow on every control.

What is the current behavior?

I need to search the web which has little info since this project is still in early stages.

What are the steps to reproduce?

You get the point...

Which versions of Angular, Material, OS, browsers are affected?

All, I'm using angular 4 with material 2 beta 3.

Is there anything else we should know?

The following are just a few examples from a couple of hours of coding:

• RTL support exists but I could find how to use it in the documentation, I found an issue, linked to a changeset leading to the relevant code.
• Dialog example doesn't show the dialog code (also the dialog is too simple).
• Input example is so simple that it doesn't cover day-to-day cases.
• I couldn't find how to make an input be in a single line (stack overflow suggested to add class="md-block" that is not longer relevant as far as I could tell).
• The documentation on adding this to system.js has very little information - A full example would help + adding on each element which imports are needed.
• It is not clear if a directive can be added to an element or needs to be an element of its own, for example: md-input-container vs. mdInput - I solve this by trail and error which is just causing me to waist time instead of focusing on my app development.

[kylecordes]

I'm not sure a catchall "better documentation" item is all that useful... But if it is, if someone is mining this list for ideas, I would like to contribute the following idea:

Ideally the example for Angular Material would result in a reasonably "full up" running demo which follows Material default guidelines pretty closely. For example it could include a nav drawer which looks like this:

https://material.io/guidelines/patterns/navigation-drawer.html#navigation-drawer-specs

The documentation could then explain how to put the various components together to achieve this guideline appearance as well as other kinds of guidelines for other aspects of Material. In other words, documentation that goes beyond "what is this component and how does it work?" into " What is the correct way to compose these components to result in an application that follows material guidelines"?

Ideally the combination of Angular Material, the example code, and the documentation would show how to end up with an appearance that follows the guidelines, without any application level CSS - application level CSS could be added (in other words, someone defying or going beyond the documentation) to vary away from a default, guideline matching appearance.

(I realize that this is potentially a huge amount of work and that I'm asking for a pony or maybe a unicorn.)

[andrewseguin]

I don't think we'll be able to actively track an issue like this, since it is so broad.

You are welcome to either open an issue for each of the documentation items you see are missing, or help us by submitting pull requests that modify the documentation.

We are happy to welcome any improvements to our docs, which are still an ongoing effort.

[HarelM]

I currently don't have the time right now to invest in understanding how the documentation engine works since I'm investing time in studying how to make material work...
Opened relevant issues, Enjoy!

[angular-automatic-lock-bot]

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}