basarat / basarat/typescript-book
Documenting TypeScript : JSDoc
Open
- Dominant language
- TypeScript
- Stars
- 21.6k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
Need at least a whole page on it.
Someone just asked on Stackoverflow : https://stackoverflow.com/a/44957356/390330 :rose:
Contributor guide
Research direction
Start by reviewing the existing TypeScript book structure and the linked Stack Overflow answer about JSDoc. The issue names no target file or page, so identify the appropriate documentation entry point, add the requested standalone JSDoc page, and verify that it fits the book's existing organization and rendering.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100