typegoose / typegoose/mongodb-memory-server
Consider Switching to typedoc for API documentation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.8k
- Forks
- 191
- Avg merge
- 4h 25m
- Merged PRs (30d)
- 10
Description
Currently all API documentation (config options, classes, enums, interfaces, types) are all done manually, but could be automated with typedoc documentation
testing typedoc branch: https://github.com/nodkz/mongodb-memory-server/tree/testTsDoc
run it with yarn run typedoc and then firefox typedoc_out/index.html (replace firefox with your browser of choice)
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 with the testTsDoc branch and run yarn run typedoc, then open typedoc_out/index.html in a browser to inspect the generated API documentation. Compare it with the current manually maintained documentation and determine whether switching to typedoc is suitable; completion should include a documented decision and its resulting documentation changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100