DoodlesEpic / DoodlesEpic/BuildUp

No API documentation

Open
#12 0 comments 0 reactions 1 assignee Assigned to @DoodlesEpic View on GitHub
bug
Dominant language
TypeScript
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

We should try to document the API separately from the code (jsdoc is not enough), the postman collection is a nice way to test the API, however, it does not give the full picture of how the API works, we should look into using Swagger or even Postman API docs tooling to generate some API documentation from an OpenAPI Schema.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.