[Story] Add link to API docs to OC web app

Sage-Bionetworks / sage-monorepo

Where OpenChallenges, Schematic, and other Sage open source apps are built

https://sage-bionetworks.github.io/sage-monorepo/

Apache License 2.0

21 stars 12 forks source link

[Story] Add link to API docs to OC web app #2208

Closed tschaffter closed 10 months ago

tschaffter commented 11 months ago

What product(s) is this feature for?

OpenChallenges

Description

The OC API docs is available on https://openchallenges.io/api-docs.

The goal of this ticket is to inform the user that an API docs is available and where to find it.

Anything else?

No response

Code of Conduct

[X] I agree to follow this project's Code of Conduct

vpchung commented 11 months ago

Do we want a page dedicated to this introduction as well (similar to Grand Challenge)?

Currently, I have simply added a link in the footer (see #2216) but can add another page if that makes more sense.

tschaffter commented 10 months ago

This is a great idea! For now we only have the API docs to share so I think it's OK to simply redirect to the Redocli-generated page. We could then add an individual page when once we have versioned API clients for Python and R.