Skip to content
This repository has been archived by the owner on Mar 16, 2024. It is now read-only.

Commit

Permalink
Initial architecture diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
cjellick committed May 31, 2022
1 parent 602eefa commit 1d92e50
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 1 deletion.
9 changes: 9 additions & 0 deletions docs/diagram-source/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
### Instructions for this directory

We are creating our diagrams using [draw.io](https://draw.io).

The source XML files for the diagrams are maintained in this directory. The corresponding image files are maintained in the `[Acorn Root]/docs/static/diagrams` directory.

To update a diagram, load its XML file into draw.io, make the necessary changes, download the updated XML, export a new image file, and commit both of those files to this repository.

Do not change either the XML or image file without updating the other as well.
1 change: 1 addition & 0 deletions docs/diagram-source/architecture.drawio
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<mxfile host="app.diagrams.net" modified="2022-05-27T22:40:53.380Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/101.0.4951.64 Safari/537.36" etag="oCWACmH3ujqzKgspYNrN" version="18.1.3" type="device"><diagram id="w-ScfHoOZrjaktbm7lLD" name="Page-1">7VvbcqM4EP0aP8bF1diPsZPMbk1S65nsVDL7siWDAtpgRAkR2/n6lYwwIAlfYmInU/MysRohUPfp091qpmdP5ssvBKTRHQ5g3LOMYNmzr3qWZTrWgP3hklUh8RynEIQEBWJSJbhHr1AIDSHNUQCzxkSKcUxR2hT6OEmgTxsyQAheNKc94bj51BSEUBHc+yBWpQ8ooFEhHbpGJf8DojAqn2wa4soclJOFIItAgBc1kX3dsycEY1r8mi8nMObKK/VS3HfTcnXzYgQmdJ8bfsb/fHu+vkkN82YxuZs52UX+18WwWOUFxLnYsHhZuio1QHCeBJAvYvbs8SJCFN6nwOdXF8zmTBbReSwuZ8+Q+pEYPKE4nuAYEzZOcMLuGAcgizZr8cEUUApJspZYBlPKGLPFEeVwYUq2x+IFIaFw2bpzc6NPBkSI55CSFZsibrAcYQKBQbM0yaKyqDMUsqhmTccWQiBQFG7WrhTNfghd6/X+8np3u3z499vy8Sl6fFjduSBcXAx2693PyctGVTAJLjma2dCPQZYhv6n3ykiGrGW4RPSRX+iPRgMx/rke26YjxldLced6sKoNppAgtmVIhKxh4BZDsG3gnPhwy/5d4cqAhJBumSfIAgYNL1UtXbOkqzFkKSMwBhS9NH1bZ1zxhClGbGcbIDlGE0iOI+Gj2Le4q+6L0kKuvWOhQjHKQgwDYFWblvIJWfsL29JzrIGx9b0c97D57vCw+QNJgdbwsPXtXe8/kOaPGvPZj0KDleNuMLSXL2s51FZ8eZwjFmaYCAH275fvU7bwIGZYHM8I+xXyX8W1lODlSnF9DvdbMGOhtOHkIEYhZ0qfuRt3yDFnRcRi1aW4MEdBwNcYE5ihVzBbr8e9VuCELe6Oe+7VNloVgVTcXIWvupe3U1orB18Y/aFtDJs8fJxTilUuvOYd+Okpg1Qy+6GG1u7QNBVLgxT1gY9J0kdYtXHKmJpGjJvDqA0AX4fMfY3LMCQwZFrAiRYM92KICY1wiBMQX1dSifyrObcYpwI6/0FKVyK7AjnFTWAxw5LVY8n6fFAECM8tx1WAWI/qEeKxFmfqt7WGlY5CiLVnCLH3DCFHxoaSaipqG70xNgx2LNQSG7pCuaWA/DmfwQuG9AyyjIQoAD0oQaznhAF8AvnaK0Ke0wh4hAQEiKFByhz3Q41CaO1JoSep2REbr6USm0SxnksM3isnND1F85PvP9gf4885r1IUBvkbhNk56KIjB7b3dGDT6tqDjzPTqM1MIAk2jE5XKStbFZMVUxCP30zjtdBxsBWPovm+2yD6HSzfrEQ25YRbJ/1TMP6+gOkcL2/KvQeWRDDG9txVydWNbnPXbSqtZzQcku/L9l1TuRIxz07ljqLWGS8JnhE9Tp9da661oD1fEDRa2FVh0kbm/Ttn7vTY5WNFXFdPUrxYjdHHciiZw8/ORKbK8A+Ab7lMV/TeVSQx3WUrx7vb+dIO71M6jVpMFJHdx4yNcBwfG9rrJVtLUXeeQq48Izyjz6klNPMrMOcaTGYZ/1P61BoOIcrKx35+c8jJ2ElTCu35rNprgcvd2mcLozRbaygCKRf6Mc6DN4WUo7pXntS9sg1NTNE1PUbvpVC1AP6az5hCIeUlrzGJ84xq6GWH3vZoDe7qLlatw446h45Uw5k63Z8UzJr8WIXuQc1CDV6lEPa2sOnsGTYLtjxXS28kHdvastfse2zryee/cu/44JbeEQe7euiozf5pnkX8OWrnIufradK8j9yW2uIwrR5u9E3P7QRJZZwp21KlujvtS+m3qMs3DuSEBgvoS9TtFWrjkLBDGtEc+rVH+XOxiNzPfzOLKA3vd/owwJML1WYj/n0a5aZayBcENOHYWDOOplEeQApQnBWzSK5vkH4+WmqJelW73DGHzXa51QlUyzs2NOWcjKbUowjFlkd89PReeYym/P9NQMd/mSRl1q6zvTsylOe7pyAs9RBl+uskRvZWBmIExFDUxILdCVZLHigPCE7GP2pX5jPwj6aO+nj840jVz8B7K/9Ipx2bLmrH/ON6B/KP3Ck7xZeFpnp09Qvxj7ODfyzPa5ZUZjf8U0b0Dr8fZMPqQ/5ievXfIezr/wE=</diagram></mxfile>
8 changes: 7 additions & 1 deletion docs/docs/06-Architecture/01-ten-thousand-foot-view.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: Ten-Thousand Foot View
---
---

The following is a high-level diagram of Acorn's architecture.

![Architecture](/diagrams/architecture.drawio.svg)

**TODO:** Document further
4 changes: 4 additions & 0 deletions docs/static/diagrams/architecture.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1d92e50

Please sign in to comment.