PAIR-code/megaplot

Generate API documentation from code comments

Open

#25 opened on Jun 15, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (3 forks)auto 404
documentationgood first issuehelp wanted

Repository metrics

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

Description

Currently, the source code includes verbose comments describing the various classes, members and methods. These should be exposed through generated documentation and made navigable from the web.

Contributor guide

Research direction
Use a documentation generator like TypeDoc to parse the TypeScript comments and output HTML, then host the generated files on GitHub Pages or similar to make them navigable from the web.
Tech stack
typescript
Domain
developer experience
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85