FGRibreau/check-build

Documentation

Open

#8 opened on Nov 3, 2014

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (695 stars) (33 forks)batch import
enhancementhelp wanted

Description

Develop a tool like "check-docs" or "dox-check" to check that at least X% functions are documented per files. Something like jsinspect but for documentation.

Then add an interface to check-build.

PR are welcome for this!

Contributor guide

Tech stack
javascriptnodejs
Domain
documentationtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
mostly clear
Prerequisites
Node.jsstatic analysisdocumentation coverage fundamentals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate existing documentation coverage tools like jsinspect's approach for code similarity, but adapt to check for function documentation presence per file. Review check build's current plugins and integration point (check build interface). Propose a tool that scans JS files, parses functions, and reports undocumented functions. Then integrate it as a plugin in check build, similar to other checks.