Added documentation of the repo for Issue #998 #1088
Conversation
There was a problem hiding this comment.
This is a great start! At this time, however, I'm not sure it's quite ready to merge into the main branch yet. While the structure is helpful for providing an overview of the different folders and how they all fit together, it's very long and may be hard to maintain. Furthermore, the parenthetical comments are frequently just the names of each folder styled differently.
It might help to limit the depth of the tree, remove some of the unnecessary folders (such as deprecated or docker), and expand more on what each folder does beyond the parenthetical expressions.
I'll leave the branch here so you or another member can work with these suggestions and continue to improve your solution. At this time, this pull request will be closed. Please open another one if you would like to provide another solution. Thank you!
|
Hola, your friendly InvestiGator bot here with another message! Because this PR was closed/merged, I'm going to remove the docs preview for now. Have a great day! Go gators! 🐊 |
Description
I added the md file that documents the repository into the docs folder according to Issue #998
Screenshot or Video
It is a documentation in .md format. It does not require compiling or running.
Related Issues
- Closes #998
Testing
Run terminal commands to open MILRepoStructure.md in the docs file
About This PR