As with our overhaul of the orchestration service, we want to make sure the newly refactored code is as clean as possible. To this end, the scope of this ticket is making sure that all functions in the DIBBs portal have docstrings, parameter type hints, return signatures, and thorough commenting throughout. Additionally, we want a markdown file walking through an overview of the system, some decision choices, and some user interface components / commands, similar to what we have in the orchestration service.
As with our overhaul of the orchestration service, we want to make sure the newly refactored code is as clean as possible. To this end, the scope of this ticket is making sure that all functions in the DIBBs portal have docstrings, parameter type hints, return signatures, and thorough commenting throughout. Additionally, we want a markdown file walking through an overview of the system, some decision choices, and some user interface components / commands, similar to what we have in the orchestration service.