ask-a-question icon indicating copy to clipboard operation
ask-a-question copied to clipboard

[DEPRIORITISED] update docs to add link to redoc

Open suzinyou opened this issue 6 months ago • 0 comments

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

  1. Add link to deployed docs on OpenAPI page description
  2. Switch top-level "API docs" link to redoc page
  3. Added/switched to redoc links in docs where appropriate

Future Tasks

Remove Swagger UI screenshots in docs website. (ticket)

How has this been tested?

  1. Run python core_backend/main.py, check HTTP://localhost:8000/redoc and /docs.
  2. 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

suzinyou avatar Jul 30 '24 06:07 suzinyou