ask-a-question
ask-a-question copied to clipboard
[DEPRIORITISED] update docs to add link to redoc
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
- Add link to deployed docs on OpenAPI page description
- Switch top-level "API docs" link to redoc page
- Added/switched to redoc links in docs where appropriate
Future Tasks
Remove Swagger UI screenshots in docs website. (ticket)
How has this been tested?
- Run
python core_backend/main.py
, checkHTTP://localhost:8000/redoc
and/docs
. - Run
mkdocs serve -a localhost:8080
and check docs
To-do before merge (optional)
Checklist
Fill with x
for completed.
- [x] My code follows the style guidelines of this project
- [x] I have reviewed my own code to ensure good quality
- [x] I have tested the functionality of my code to ensure it works as intended
- [x] I have resolved merge conflicts
- [x] I have updated affected documentation