Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DEPRIORITISED] update docs to add link to redoc #334

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

suzinyou
Copy link
Collaborator

@suzinyou suzinyou commented Jul 30, 2024

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.

  • My code follows the style guidelines of this project
  • I have reviewed my own code to ensure good quality
  • I have tested the functionality of my code to ensure it works as intended
  • I have resolved merge conflicts
  • I have updated affected documentation

@amiraliemami amiraliemami changed the title update docs to add link to redoc [DEPRIORITISED] update docs to add link to redoc Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant