Repository navigation
Better internal services documentation #24
Description
Currently there are three services, all of which have few pretty complex route. To make this project more accessible, we need to have better documentation about all the services.
Here's what we need at the least (for each service):
- All the endpoints
- Schema of all requests
- Schema of all responses
- Examples
I believe this can be done in two different ways. First would be putting all this information in README files. The second way could be that we do this in our official documentation.
Activity
[-][doc] Better services documentation[/-][+]Better internal services documentation[/+]supreme-gg-gg commentedon Aug 31, 2025
This seems to be done in most services now, including
preprocessing, jobs/training-job, training, inference! They now include: endpoints docs, schema docs, schema example, and a technical description of what's going on. Currently these technical docs are inREADME.mdin each directory. User docs will be separated in either another repo ordocssee #54 for work in progress.I'll close this first it seems to be completed as I've been updating docs along the way