manrajgrover/algorithms-js

Improve documentation interface

Open

#23 opened on Aug 5, 2017

View on GitHub
 (8 comments) (0 reactions) (0 assignees)JavaScript (132 forks)github user discovery
documentationgood first issuehacktoberfest

Repository metrics

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

Description

Better interface is needed (this could be some other documentation generation tool, if required)

Contributor guide

Research direction
Evaluate the current documentation interface and propose improvements. Consider alternative documentation generation tools if needed.
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.
2
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.
Mostly clear
Prerequisites
GitJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75