[DEPRIORITISED] update docs to add link to redoc #334
+14
−15
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reviewer: @amiraliemami
Estimate: 10 mins
Ticket
Fixes: None
Description
Goal
Link to redoc page for API docs, unless the guide is for testing the APIs. (Swagger UI allows for testing APIs, redoc doesn't)
Changes
Future Tasks
Remove Swagger UI screenshots in docs website. (ticket)
How has this been tested?
python core_backend/main.py
, checkHTTP://localhost:8000/redoc
and/docs
.mkdocs serve -a localhost:8080
and check docsTo-do before merge (optional)
Checklist
Fill with
x
for completed.