Use GitHub mermaid to create class diagrams to document the relationship between different objects. This is part of #444
In an effort to improve documentation and make it easier for new TAs to become familiarized with the Autograder, it would be beneficial to create class diagrams to showcase the interactions that each class has with the other. Multiple class diagrams that showcase specific relationships and help in understanding control flow might be more beneficial than one all-comprehensive class diagram.
Especially important would be:
- Server/Service/Dao interactions
- SubmissionService/Grader/TrafficController interactions
- Anything else that might be hard for a newcomer to understand
Use GitHub
mermaidto create class diagrams to document the relationship between different objects. This is part of #444In an effort to improve documentation and make it easier for new TAs to become familiarized with the Autograder, it would be beneficial to create class diagrams to showcase the interactions that each class has with the other. Multiple class diagrams that showcase specific relationships and help in understanding control flow might be more beneficial than one all-comprehensive class diagram.
Especially important would be: