UniversalMediaServer / UniversalMediaServer/api
API docs
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 12
- Forks
- 3
- Avg merge
- 16d 31m
- Merged PRs (30d)
- 6
Description
We are the intended consumer but it could be helpful even for developers if we can create some API documentation in a way that is as automated as possible.
I'm thinking some sort of JSDoc/Swagger automated thing
Contributor guide
No contributing guide indexed for this repository
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
No files, tests, or entry points are named. Start by inventorying the TypeScript API and comparing the proposed JSDoc and Swagger automation approaches; done means generated API documentation is available for intended consumers and developers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nodejs, typescript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100