V2 API Specification#68
Conversation
This reverts commit 101687f.
Matgenius04
left a comment
There was a problem hiding this comment.
Overall, the documentation looks good! There are some super minor spelling mistakes I noticed.
I'm thinking of using GitHub Pages to host these, but it's a little bit tricky figuring out how to make everything work together nicely. I think if we're able to unify everything into one /docs folder from the root level directory with all the static assets for documentation, that'd be ideal.
NOTE: I have not actually validated whether the v1 or v2 APIs actually line up with what is described in the documentation.
|
Before merging this, we need to host this documentation on GitHub pages. |
|
I have read over the v1 docs and they seem consistent with the code |
…s/COMS-Console into dev/v2-api-specification
|
Documentation is on this site: https://rit-coms.github.io/COMS-Console/ |
|
I think the v2 routes should be implemented in a separate branch. This PR is ready for review. |
Updated workflow to trigger on 'main' and 'release/v2-dev' branches on push.
Removed deployment step for GitHub Pages (This will be moved to another action).
Issue
Closes #67
Major Changes:
Setup / How to Test:
Testing Considerations: