lipp / lipp/doclets

TypeScript support

Open
#263 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

If I point doclets at `src`, I get this:

Error: ENOENT: no such file or directory, open '/usr/src/app/lib/7ea90b80-bf77-11e6-895d-f541a01addf8'

If I point it at `dist`, I get a [bunch of comments with no signatures](https://doclets.io/material-motion/indefinite-observable-js/add-to-doclets#dl-IndefiniteObservable-subscribe)

For comparison, [documentation.js](https://github.com/documentationjs/documentation) doesn't know how to read .ts files, but it shows their interfaces correctly if you point it at the generated TS file.

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

Reproduce the behavior by pointing doclets at `src` and then `dist`, and compare the generated output with the linked documentation.js behavior. Trace the TypeScript input and generated-file handling from those entry points; done means `.ts` interfaces and signatures are documented without the ENOENT error.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.