prikhi/pencil

Add User Documentation

Open

#703 opened on Jun 2, 2015

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (1,933 stars) (199 forks)batch import
Docsenhancementhelp wanted

Description

It'd be nice to have a Users section for the docs filled with pictures and steps on how to do things :)

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.
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic familiarity with pencil
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Review any existing documentation in the repository to understand the current structure. Look for a documentation directory or a wiki. The issue asks for a 'Users' section with pictures and step by step instructions. Create markdown files and include relevant screenshots of the pencil tool. Ensure the documentation is well organized and linked from the main documentation index.