mike-north/ember-cli-materialize

[Proposal] - Docs - Link to materializecss docs

Open

#247 opened on Sep 14, 2015

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (305 stars) (117 forks)batch import
enhancementhelp wanted

Description

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

Contributor guide

Tech stack
javascriptcss
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of Ember CLI addon documentation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
The issue proposes adding links to the official Materialize CSS docs for each component to avoid duplicating documentation. Check the existing documentation files (e.g., colors.md) in the repository. Since this is a proposal, review comments for any discussion on scope. The maintainer may need to confirm the approach before adding links. Suggested files: app/templates/components/ and documentation files.