Add API Phase 1 documentation

florentianayuwono commented 1 year ago

Description

Documentation in markdown for SSID API Phase 1 .

Related Issue

Part of #324

Motivation and Context

Detailed guide on how to use SSID API.

How Has This Been Tested?

No testing required except for the automated checks.

Screenshots (if appropriate):

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[x] My code follows the code style of this project.
[ ] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.

coveralls commented 1 year ago

coverage: 0.218%. remained the same when pulling 18c1dd02b555c0fc460cb437d5d67b3c4fbdf106 on florentianayuwono:api-doc into 5ffee50643a836a6ba3e8a6e5a29eb2bcfb87345 on WING-NUS:master.

sibinhho99 commented 1 year ago

Remember to mark status as "Pending Review" under SSID Project so that it shows up on the Project Kanban board. Otherwise LGTM

florentianayuwono commented 1 year ago

Thank you for the detailed review Sibinh!

WING-NUS / SSID