mike-north/ember-cli-materialize

Improve documentation for forms

Open

#96 opened on Apr 26, 2015

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

Description

http://sgasser.github.io/ember-cli-materialize/#/forms

Things that are insufficiently documented

  • Combining a bunch of elements to build a form
  • Update example of how to use the form components with ember-validations

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.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
clear
Prerequisites
Ember.js basicsMaterialize CSSMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Examine the current forms documentation at the provided URL and in the repository's documentation directory. Identify the missing sections listed in the issue, particularly on combining form elements and integrating with ember validations. Review any existing comments for additional context. Update the relevant documentation files with clear examples and explanations.