Added Architecture and Design Doc #1012
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…/Software into mathew/architecture_doc
Added robot status
Added design patterns
Combined the convention diagrams
done |
|
Made a bunch of changes, ready for re-review |
MathewMacDougall
requested review from
phelanm20,
HaomiaoZ,
garethellis0,
matthewberends,
jonathanlew and
EvanMorcom
jonathanlew
previously approved these changes
Nov 11, 2019
garethellis0
requested changes
Nov 11, 2019
MathewMacDougall
dismissed stale reviews from EvanMorcom and jonathanlew
via
7305e74
|
Updated the |
|
@scveloso @matthewberends @jared-paul need re-review (and approval) |
|
@scveloso @jared-paul can you please take another look so we can wrap this up? |
jonathanlew
approved these changes
Nov 15, 2019
scveloso
approved these changes
Nov 15, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please fill out the following before requesting review on this PR
Description
Added a big document that explains our architecture, system design, important components, and design patterns.
I also tweaked all the other docs to either fix links, or make minor updates.
I'm tagging more people than usual for review, since this will really benefit from more eyes and opinions. Please comment if anything isn't clear, if I missed anything, etc. We really want this documentation to be solid so it's useful to everyone.
The documentation focuses more on higher-level concepts and ideas, rather than any specific implementations since those can be read in the code, and we don't want to have to update the documentation often. That being said please let me know if you think sections need more detail.
HOW TO REVIEW
Reading raw markdown isn't easy. I'd recommend clicking "View file" for each changed file and just reading the nicely formatted markdown. If you have something to comment on, then go back and find the closest change and leave a comment there.
Testing Done
N/A. Manually made sure as many links work as possible.
Resolved Issues
resolves #878
resolves #879
resolves #880
Length Justification
The architecture doc is pretty big, and I wanted to do everything all at once to make linking easier.
Review Checklist
It is the reviewers responsibility to also make sure every item here has been covered
.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.TODO(or similar) statements should either be completed or associated with a github issue