MichalLytek / MichalLytek/type-graphql

API reference with JSDocs

Open
#17 5 comments 5 reactions 1 assignee Claimed by @MichalLytek View on GitHub
Documentation :book: Good First Issue :wave: Help Wanted :sos:
Dominant language
TypeScript
Stars
8.1k
Forks
672
PR merge metrics
No merged PRs in 30d

Description

- [ ] create JSDoc for all decorators and public interfaces/functions/etc.
- [ ] create docs section with API Reference (text from JSDoc, samples from item signature)
- [ ] investigate usage of [TypeDoc](https://github.com/TypeStrong/typedoc)
- [ ] configure website to show API reference

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.