mike-north / ember-cli-materialize

Material Design (via Materialize) for Ember.js Apps
https://mike.works/ember-cli-materialize
MIT License
300 stars 113 forks source link

[Proposal] - Docs - Link to materializecss docs #247

Open rtablada opened 9 years ago

rtablada commented 9 years ago

I think we'll be running around in circles trying to duplicate the full docs of materialize. So my thought is that for every component, we should link to the relevant original docs so we don't have to do double duty.

This would also eliminate the need for things like the colors.md file

cravindra commented 9 years ago

+1

rtablada commented 9 years ago

I need to think this through more and figure out what is valid to have a copy of locally and what should be linked to materialize's main docs...

cravindra commented 9 years ago

I think every component can have:

  1. Title
  2. Link to MaterializeCSS docs
  3. A description of all the available properties on the component - and how to use them. (Not just a listing)
  4. Caveats and special FYIs, if any.

A good example of ambiguity is the md-select component. The mapping of the component properties (and expected formats of the data its being mapped to) are not intuitively obvious. See #131