moscajs/mosca

Write documentation in plain markdown

Open

#501 opened on Jun 18, 2016

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

Repository metrics

Stars
 (3,186 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently the documentation is written inlined in the code, using a (now-broken) documentation generation system.

We should rewrite this into a doc folder just using "plain" markdown.

Contributor guide

Research direction
Review the existing inlined documentation in the source code, then create a new 'doc' folder with plain markdown files that replicate the content in a structured way.
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90