DavidWells / DavidWells/jsdoc-parser

Idea: Autolink known types to MDN docs

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

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
10
Forks
0
PR merge metrics
No merged PRs in 30d

Description

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 reviewing the linked typedoc-plugin-mdn-links project and the jsdoc-parser repository description to understand the intended MDN linking behavior. Determine which known types should become links and define a testable set of expected links; the work is done when the parser autolinks those types to the appropriate MDN documentation.

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
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.