gcanti / gcanti/docs-ts

`@types/node` is needed

Open
#32 2 comments 0 reactions 0 assignees View on GitHub
accepting PRs good first issue
Dominant language
TypeScript
Stars
105
Forks
18
PR merge metrics
No merged PRs in 30d

Description

You need to run `yarn add -D @types/node` on your project if you want to make use of the `assert` module in the `@example` section. Otherwise you get an error when generating the docs.

This should be either mentioned in the readme or included as a (peer)dependency?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by checking the README and the package dependency configuration for how the `@example` section and the `assert` module are handled. Reproduce documentation generation without `@types/node`, then make the documented or dependency-based resolution explicit and verify that docs generation succeeds.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, typescript
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.