kazupon / kazupon/api-docs-gen
docs generating from TypeScript Codes
Open
Priority: High
Type: Feature
- Dominant language
- TypeScript
- Stars
- 29
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
### Implementation
- Use TypeScript Compiler API
- Use Trivia API: https://basarat.gitbook.io/typescript/overview/ast/ast-trivia
- ref: https://quramy.medium.com/manipulate-comments-with-typescript-api-73d5f1d43d7f
Contributor guide
Research direction
The issue names the TypeScript Compiler API and Trivia API as starting points; read those references before inspecting the repository for the documentation generator entry point. The issue does not identify files, tests, output requirements, or a concrete completion condition, so the expected generated documentation must be clarified first.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100