Docs: Improve Overall Documentation of AutoGrader Before Spring 2025

[frozenfrank]

Motivation

By Spring of 2025, all of the current contributors to the AutoGrader project will have graduated and left.

Goals

We want to use the principles learned from other classes to leave behind meaningful documentation so that:

1. New TAs can get started developing and maintaining the AutoGrader
2. Existing TAs can understand how the system works at a high level
3. The project can continue and evolve to meet future needs of the CS 240 class and maybe be used in other contexts as well.

Work List

Abbv.	Meaning
SD	Sequence Diagram
PD	Block Diagram (Mermaid's best shot at a package diagram)

This major project can be accomplished in steps which are represented as separate issues:

• [x] #451
• [ ] #445
  • Package Diagram
  • Sequence Diagram
• [ ] Commit Verification
  • Commit Verification SD
  • Commit Verification PD
• [ ] External Gradebook (Canvas) Export SD
• [ ] Phase Graders SD
• [ ] Stopping & Starting System SD
• [ ] #448
• [ ] #461
• [ ] softwareconstruction240/softwareconstruction#150

Evolving Project

The deadline for this project is fixed, but the exact scope of it can change.

Edit this Issue description to modify and adjust the items that should be included.

Key Contributors

@19mdavenport @webecke @frozenfrank

[webecke]

@19mdavenport is this issue done? If so, are we going to mark it closed?

I guess that might depend on our meeting later today.

[frozenfrank]

Update: I attempted to organize this work using a GitHub Milestone, but I found the "Milestones" feature to be underdeveloped for our purposes. Specifically, the feature doesn't support linking issues that span multiple repositories. Leverage this "Epic" style umbrella issue will be just fine for our purposes.