ipfs/ipfs-companion

Reuse comments as documentation

Open

#572 opened on Sep 11, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (364 forks)batch import
good first issuehelp wantedkind/maintenancestatus/deferred

Repository metrics

Stars
 (1,992 stars)
PR merge metrics
 (Avg merge 53d 3h) (1 merged PR in 30d)

Description

We have comments in key places, but we could refine them and use something like documentation.js to make then even more useful.

Contributor guide

Research direction
Explore how to integrate documentation.js to generate documentation from existing comments in the codebase. Start by reviewing the comments in key files and consider refining them for better output.
Tech stack
javascript
Domain
documentation
Issue type
Feature
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80