mike-north/ember-cli-materialize

Improve documentation for md-collapsible

Open

#94 opened on Apr 26, 2015

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

Description

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

Things that are insufficiently covered

  • Expandible vs. accordion mode (whether 1 or N panes can be expanded at a given time)
  • Pre-selected selection example is currently broken
  • "Popout" collapsible

Contributor guide

Tech stack
javascript
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
Familiarity with Ember CLI addon structureBasic knowledge of Materialize collapsible
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the existing documentation for the md collapsible component in the addon's source (likely within an 'addon' directory or 'app' directory). Check the template files for collapsible (e.g., components/md collapsible.hbs) and any related JavaScript files. The issue mentions three specific areas: expandible vs. accordion mode, pre selected selection (currently broken), and 'popout' collapsible. Look for existing documentation files in a 'docs' or 'tests/dummy' folder to understand the current setup. Update the documentation to cover these missing aspects, and fix the broken pre selected selection example if possible. Refer to Materialize CSS documentation for correct usage.