lipp / lipp/doclets

Show JSDoc errors/warning

Open
#93 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
206
Forks
12
PR merge metrics
No merged PRs in 30d

Description

Show warning / errors during JSDoc generation. This will help the user figure out what's going on (e.g. something missing see #75).
Maybe on user/repo view (dashboard)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing JSDoc generation and the user/repo view or dashboard mentioned in the issue. Determine where generation warnings and errors are currently lost, then verify that users can see them when documentation generation completes or fails.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.