mike-north/ember-cli-materialize

Improve documentation for md-navbar

Open

#93 opened on Apr 26, 2015

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

Description

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

Things that are insufficiently covered

  • Right-aligned links in "desktop" mode
  • Left-aligned links in "desktop" mode
  • Active items
  • Navbar dropdowns
  • Fixed-to-top navbar
  • Icon links
  • Search bar
  • Responsive navbar
  • Changing the navbar color and/or text color
  • Icon logo

Contributor guide

Tech stack
javascripthtmlcss
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
Ember.js fundamentalsMaterialize CSSHTML/CSS basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Review the current documentation at the URL provided in the issue and the md navbar component code (likely in addon/components/md navbar.js and templates/components/md navbar.hbs). Check the linked comments for any additional context. For each checkbox item, find where the corresponding feature is implemented (e.g., right aligned links, active items) and write clear documentation explaining how to use it. Ensure consistency with existing documentation style and submit a PR with the changes.