ndif-team/ndif

Add documentation (README) for API service

オープン

#169 opened on 2025/10/20

 (0 件のコメント) (0 件のリアクション) (0 人の担当者)Python (17 件のフォーク)github user discovery
documentationgood first issue

Repository metrics

Stars
 (45 個のスター)
PR merge metrics
 (平均マージ 7h 27m) (30d で 4 merged PRs)

説明

Description

Currently, the API service is missing basic documentation. A README should be added which includes the following:

  • A description of what the API service is and how it is used in NDIF.
  • Directory structure + explanation of main files.
  • A list of all the endpoints and their functions.
  • A brief description of the main library dependencies and what they are used for (and remove any that are no longer being used from environment.yml)
  • A list of any relevant environment variables and what they are used for (checkcompose/dev/docker-compose.yml, compose/dev/.env, and the source code). Emphasize the env vars which developers would be most likely to care about (port, number of guvicorn workers etc)
  • State somewhere that we don't yet support running the API isolated from the other services (i.e. can't just spin it up by itself using docker / compose / command line)

And anything else you think would be useful to add.

Even if you don't have answers to most of these questions, feel free to kickstart a PR - one of the developers would be happy to work with you on it.

コントリビューターガイド