Skip to content

Commit

Permalink
added links to some documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kevindeland committed May 31, 2019
1 parent cb6fbf8 commit a2b0dbd
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions DEVDOCS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# RoboTutor Dev Docs


### High-Level Architecture
Follow through [these slides](https://docs.google.com/presentation/d/1aYhuYrvfDt1mmqlsfI_TCanWVKqywG-euNVGjZ4Kwn4/edit?usp=sharing) for a high-level overview of how the architecture works.



#### Animator Graphs
- Look at [these images](https://drive.google.com/drive/folders/1rHqBC5_aGb7NrNjdL7lgm8z43-6Y3bPh) to see what an animator graph looks like in state diagram form.
- Follow along with [this document](https://docs.google.com/document/d/1WG6C3wKL-UL72X3ANHvtt5Yz89lWf2ijWGnxI5DcF1A/edit#heading=h.plk4k4ssrpp0) to see how an entry in the `queueMap` is called.
- Follow along with [this document](https://docs.google.com/document/d/1qhevkDbn7Bv9MO5SJt4udGXPgpWWfzEJEOnv1W1YTtA/edit#) to see how to publish "features" to the animator graph.


#### Student Data Model
- [Here](https://docs.google.com/document/d/1G3Ev8L3cRdMiV5jmnm3JrVShbFeOQKuDSWqMWXfWTt0/edit#) is a list of all the variables that are stored in the student model.

#### How XPrize Installation Process works
Follow throug [these slides](https://docs.google.com/presentation/d/1eXESVDWKcZsDOPJ1yRm-zi6KgF8DtFroOJtUVM0OkdQ/edit#slide=id.p) to see how the System Build Process works.



#### Documentation of individual components
- See [this doc](https://docs.google.com/document/d/1Ss1oqgr8xI6Q_k3OjBEMnkZPAFwPiWwyMXC49rz8nt0/edit) for documentation of the WRITE component.
- See [this doc](https://docs.google.com/document/d/1YTZiQavbtHnTHD38-JlMCs08m7knb8QnsvryEfCItx0/edit) for documentation of the BubblePop component.
- See [this doc](https://docs.google.com/document/d/162bHV7LsszAvT2ehfpk5IwA2QUQpw7f3EwA_DMF9F08/edit#heading=h.svv2thg275va) and [this doc](https://docs.google.com/document/d/162bHV7LsszAvT2ehfpk5IwA2QUQpw7f3EwA_DMF9F08/edit#heading=h.svv2thg275va) for details on how the BaseTen Math component works.



#### Other useful things
- Learn a coding strategy I use to make TODO comments [here](https://docs.google.com/document/d/15UEfdJw6MXRogx7gKiw07lI_auZNXz6n886I6dFli7A/edit#).
- Here's [a list](https://docs.google.com/document/d/1JS9Q4wUUM56wd7vVOQ5aZKFJrlbfMYIg9sRK1prReaI/edit) of the most common things you might need to know. Unfortunately, none of them are documented.

0 comments on commit a2b0dbd

Please sign in to comment.