Software
Software copied to clipboard
UBC-Thunderbots
Update "Getting Started" and software architecture docs
Description
Testing Done
Resolved Issues
Resolves #1854 Resolves #3312 Resolves #3126
Length Justification and Key Files to Review
Review Checklist
It is the reviewers responsibility to also make sure every item here has been covered
- [ ] Function & Class comments: All function definitions (usually in the
.hfile) should have a javadoc style comment at the start of them. For examples, see the functions defined inthunderbots/software/geom. Similarly, all classes should have an associated Javadoc comment explaining the purpose of the class. - [ ] Remove all commented out code
- [ ] Remove extra print statements: for example, those just used for testing
- [ ] Resolve all TODO's: All
TODO(or similar) statements should either be completed or associated with a github issue
![notion-workspace[bot] avatar](https://avatars.githubusercontent.com/in/300037?v=4 "Published by a pub.dev verified publisher"){kind=small}
This PR is stale because it has been open for 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
Made changes to our software architecture doc:
- Rewrote Strategy / STP sections
- Replaced Navigation section with newly written Motion Planning section
- Got rid of some outdated sections (e.g. Intents)
- Moved around some sections so that the information is ordered more sensibly IMO
I'd like to update/add diagrams at some point but I think I will do that in a different PR.
This PR is stale because it has been open for 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.
This PR is stale because it has been open for 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.
This PR is stale because it has been open for 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.
This PR was closed because it has been stalled for 5 days with no activity.