This repository was archived by the owner on Sep 5, 2024. It is now read-only.
Repository navigation
This repository was archived by the owner on Sep 5, 2024. It is now read-only.
md-dialog and md-dialog-content are not documented #4728
Description
The Angular/Material DIRECTIVES sidebar does not show these directives at all.
This is a complex subject that really should have detailed API and a few decent demo examples.
Perhaps someone who is not a newbie (as I am) to Angular/Material could correct this in the next release.
Activity
ThomasBurleson commentedon Sep 19, 2015
This is what we have currently: https://material.angularjs.org/HEAD/#/api/material.components.dialog/service/$mdDialog.
Your feedback is useful, however, in that it highlights a confusion point where developers may only search the Directives sublist.
djmarcus1 commentedon Sep 19, 2015
I had already seen the page (https://material.angularjs.org/HEAD/#/api/material.components.dialog/service/$mdDialog).
In fact, it helped me enough to get me going, but honestly dialogs are a big part of modern user interaction... and they can get fairly complex. Therefore, they should, at the very least, include a formal demo link from that page, and there needs to be a whole discussion with cookbook samples to illustrate how to do top-notch dialogs. I learn fastest by seeing examples. All the progress on my dialogs that I have made have come from seeing CodePen examples.
Don't misunderstand my feedback. I am incredibly impressed with Angular/Materials... its amazing and the best framework I've seen on top of Angular. Yet, the key for its widest adoption is to reduce the learning curve. This can only be achieved by having great documentation and copious examples.
:-)
ThomasBurleson commentedon Sep 20, 2015
The Angular Material Core team completely agrees. Unfortunately, we are focused with 100% capacity on the upcoming v1.0 release: stabilization, polish, and performance are the main focus areas.
Would you be interested in helping with the Dialog docs?
djmarcus1 commentedon Sep 20, 2015
For sure.
Is there any information on how to update the docs (and the website pages)?
You can reach me directly at my email of djmarcus with the domain name of m5inc with top level of com.
-David
ThomasBurleson commentedon Sep 20, 2015
@Splaktar - Do you have time to help ramp @djmarcus1 upon the fork-branch-update-pullrequest process ?
Splaktar commentedon Sep 20, 2015
Yep, I will contact him in an hour or two.
Splaktar commentedon Sep 21, 2015
Email and Hangouts request sent to @djmarcus1.
In the mean time, please take a look at https://github.com/angular/material/blob/master/docs/guides/CONTRIBUTING.md
Splaktar commentedon Sep 22, 2015
Spoke to him last night and made a lot of progress getting him up and running.
10 remaining items
topherfangio commentedon Nov 3, 2015
@Splaktar @djmarcus1 I am pushing this off to the next RC release. Has any progress been made on this yet, or do I need to just start from scratch? 😄
docs(dialog): added docs to the elements and fixed controller
docs(dialog): added docs to the elements and fixed controller
Splaktar commentedon Nov 27, 2015
From scratch. I got him setup to contribute, but he has been busy with other things. He said that he meant to contribute, but he didn't give an ETA.
Splaktar commentedon Nov 27, 2015
Actually he said that he had some minor updates made locally, but needed to create the PR. That was a month ago though. I will follow up, but I don't think that we should wait longer than another day to improve these docs.