adopted-ember-addons/ember-light-table

Improve Documentation

Open

#54 opened on Jun 13, 2016

View on GitHub
 (9 comments) (0 reactions) (0 assignees)JavaScript (130 forks)github user discovery
help wanted

Repository metrics

Stars
 (312 stars)
PR merge metrics
 (PR metrics pending)

Description

  • Annotate each available component property with a helpful description and maybe an example where possible
  • Cell Type and Column Type --> What they are and how they can be used (including their appropriate blueprint generators) #91
  • Add overall examples in module homes
  • Maybe rename the modules to make everything easier to read? I feel like the docs right now are really hard to follow IMHO

Contributor guide

Research direction
Read the existing documentation and component source code to understand current properties. Then propose clear descriptions and examples for each property.
Tech stack
javascript
Domain
frontend
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitEmber.js basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70