adopted-ember-addons/ember-cp-validations

Cleanup Docs

Open

#193 opened on May 23, 2016

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (173 forks)github user discovery
documentationgood first issue

Repository metrics

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

Description

I believe its time for a demo page / docs overhaul. A lot of issues have been opening up because of either lack of documentation or it just being confusing. This issue has been opened to track what needs to be changes / added.

  • General cleanup (spelling / grammar mistakes)
  • Add some better examples
  • Add note on testing (i.e. needs: ['validator:presence'])
  • Maybe restructure to make things easier to find
  • New demo page with code snippets

Contributor guide

Research direction
Review the current documentation and identify areas that need cleanup: fix spelling/grammar, add missing examples, include testing notes, restructure for navigability, and create a demo page with code snippets.
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.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75