OpenAPITools / OpenAPITools/openapi-generator
typescript-nestjs [REQ] Add documentation for typescript-nestjs
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
There is no guidance on how to use the generated output of the typescript-nestjs generator. I do not know how to use these files and what needs to be configured.
Describe the solution you'd like
A very basic example of how to actually use one of the generated services.
Describe alternatives you've considered
Looking through the code has not given me enough information to get it to running without errors.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the typescript-nestjs generator's existing documentation and generated service entry points. Reproduce the reported setup, then document a basic service example and required configuration; done means a new user can run the generated output without errors.
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
- 35/100