You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adam Bosen edited this page Aug 27, 2026
·
1 revision
As features are implemented and issues are addressed, developers should take notes on how that work was done. Much of this documentation can be contained in source code comments, which can be extracted by Github actions from markdown comments. These documents should clearly describe what each major component of the project does, how it does it, and how those components align with project requirements.
Developers, please keep this document up to date as you implement the project. Ideally, this section should be an easy way to communicate project progress to other team members and help onboard future developers who may need to revise or expand on the project.