ndif-team/ndif

Add documentation (README) for Ray service

Open

#171 opened on Oct 20, 2025

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (17 forks)github user discovery
documentationgood first issue

Repository metrics

Stars
 (45 stars)
PR merge metrics
 (Avg merge 7h 27m) (4 merged PRs in 30d)

Description

Description

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

  • A description of what the Ray service is and how it is used in NDIF.
  • Directory structure + explanation of main files.
  • List all the main classes (Controller, Cluster, Node, etc) and give a brief description of what they are.
  • 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).
  • Add a section for spinning up the Ray service from the command line (I can help with providing content). Can mention that it can be spun up but won't work without the API.

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.

Contributor guide

Research direction
Inspect the Ray service directory structure, identify main classes (Controller, Cluster, Node) and their roles, check environment.yml for dependencies, examine compose files and .env for environment variables, and review source code. Then compile that information into a README following the outlined sections.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70