Skip to content

Commit a8a2cc6

Browse files
authored
Merge pull request #59 from mcode/doc-updates
Documentation Updates
2 parents b4b42b3 + fd2e546 commit a8a2cc6

9 files changed

+4
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ This framework consists of three key components: Extractors, Modules and Templat
5252

5353
### Glossary
5454

55-
![Image detailing exact definitions of what is meant by Client, Extractor, Module and Template](./docs/diagrams/terminology-breakdown.png)
55+
![Image detailing exact definitions of what is meant by Client, Extractor, Module and Template](./docs/diagrams/20_11_23_steam-terminology-breakdown.png)
5656

5757
### High Level Diagram
5858

59-
![High-level architecture diagram, detailing exactly how Clients, Extractors, Modules, Templates and various web services communicate with one another](./docs/diagrams/high-level-arch.png)
59+
![High-level architecture diagram, detailing exactly how Clients, Extractors, Modules, Templates and various web services communicate with one another](./docs/diagrams/20_11_23_steam-high-level-arch.png)
6060

6161
These diagrams can be modified by updating the XML files in the `/docs/diagrams/` directory using draw.io or a company licensed equivalent.
6262

Loading
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<mxfile userAgent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.67 Safari/537.36" version="7.5.6" editor="www.draw.io" type="device"><diagram id="866f9370-945e-b958-1e14-63ab040b194e" name="Page-1">7V1Zk6M2Hv80rtp9MAWSuB77mNlJVXa3K51Udh9pW7bZwcjhmO7Op18JJEAHBhvs7p5MP2SMEEL+H7//KWcB7/Yv/8iiw+6fZI2TBbDXLwt4vwAAwMCm/7CR13rEcSGqR7ZZvOZj7cBj/Cfmg/zBbRmvcS5NLAhJivggD65ImuJVIY1FWUae5WkbkshvPURbrA08rqJEH/09Xhe7ejRw7Xb8C463O/Fmx+Z3nqLV121GypS/bwHgpvqrb+8jsRafn++iNXnuDMFPC3iXEVLUn/YvdzhhxBVkq5/73HO32XeG02LMA7B+4FuUlFjsuNpX8Spowb7OQV+Xv+obzgr8YmJK9CRWaL8YlRhM9rjIXuk8/pSPwvo5LizAAZZbjzy3tA99vvquQ/dACFrE+b1tVm+/M/3Av7aZBGiYBBVDMZtvL+Dt8y4u8OMhWrG7z1QD6Niu2NP17x36cRMnyR1JSEavU5LSSbc69WAP9XqpFFp+ABCELnCgC33kGyhkW8DxXc9DfuAhD16IXu5YkYG36yjfVWRz+MVDVBQ4S6sRYCM6mhcZ+YoVesn0Hk+9k2Uv1KjooNBCCAU2cP3A9Vwv1MkIZ6CiN7PU6URye4jUSwx7UMQcFFieB6AX2q5PUS8ElyGOrxFnf/fv+0906NNLkUWrIiYpvficRXv8TLKvGunoNy5k+hjlzKCqURJvmXyuKB0xHb9l9IupZbjhN/bxes1eY2TIkOCO58kbiGRgEEkvYXTcEPoFugT2/iiJuLHMK/N9QycAdHhpb9JPW/5vtcqTGOBMJFne3MrUyXSzT+pY3CwQrXb0dVisw4gRpZQtdEFbXxN3hYbOY//dbjO8jfgY2egPMXGgd9jae5Kxz0IGM5yTMlvhvLPX2LD/mmry8Dr+pg7NQ1xtA0aSjt0mHTbs9Mfmf2x+ns3nhyh9y83X7x/xsLT3KfZZtj80LLCrP7MRykhRQ9OpDlCvbQ9cyccOAs22Q2SbzAqYblfCa9kVGoiWCZ5oVPbVIpJFyfAfJc4LtnC0Z3xNn/KDUXIKwmxGZTnWURGx71aZijN0KZ5EmIF9vsMR445len1g/XNDW1JARzhsQxqIvBk8O5FWubwK/or3hyQqpiphwZehH5PolekgKYtxQtL32mbKjjxX6aSOF9jqq/p0nNYTGf8zQkUFM+/x85effuk4gj0bGamDmv5/YDEPkCUbGhToUaRRzh0PzSDnjibnvzTYbW8qZ34dbza4+oqDHFqR/YFSKq2ermKEgQdEhIATvK/foEyohUxhME7XNyxnyaLOJMrzeDWWp/UdkaFkc/FLXNy/cIZWF6/iIqXE/A+7sGxq1fnAf+sBT1y3z1ZX0sMPOIspS1hUfFxeiijb4kIy/ngtJVx7BWjJducoMqRDpWuQIDGWYYoc8Tc5k2uSKr6JBxJXEMh3gEQc3OSufSHTYpFa6/lz3eSqspQLFdBXsbwm1JGFxESy2eRYmlOpQkO/cdoBDFbgwrIoBE5c1/IGbf+4rNILVdoa+XXoclCWX88OZhVgDutdAe7KdDBSpq8ksIprAdQk72hxRcpCalKpR1zPEUW97vBTSmOteF1GSes8cxw1OBN/w9bWojMeKOUqpKWvtO8IXaNO6dz1gXUnoMPFyvr7yFhPTyiOTxRSNyH+k2ekmdgdGAErkrq3C/eejiTRE05um9JRR7148cgkq406T86CM9ANXV9i/hLOIpxLxxL7FAsD1wqUdeaBtxGFnMvAm1fbTw5vFJ8GLPExdKOrOV1wqwxiOAnBAh3BREDwXiDMkZEHhmdCWBMtiYXQ5SBMr4Pd16hV+5mdSOgDYInQnVmwRHXg3FmEBFqhoyAJsELFNZsHSUYU52ZFkmOOSy+M9Or+O1FqYMt1fRoKnutIq0vBUFtqRsXurz62KQDVH1EyAh9D6YWYz6H0wIOKAzFR61+ND8yj36ZKZ79+82yJ1MzQ7fcgacE7mCiMyoGKI9ly20LQOdmUnxNNX0fDXVH/F2oJztZwT4k9oH9JDZ9ekXCC0wpTYuBfpEo2/l5tqD8fOk9FWbTViW2icTuW4ib2ZfPyqVK6KgfGCyQsJRaxsrg8PY8LvMwPeBVvqEUU1fZPX37pDF6g0DgIttdp/1ChoFenx2dUPdU1drmadlQchMaEativz2MTqkBPqH5XmqI9eoLq6JqBO30ttXLYw/rAshh3ZcZEJHmt8xjSOs9xxZEUV5WHqhrxxFYuD2saXbCxdZxRW51UuL/DqaSi22p3fK41rFUmWv5FNM1RNA0gMFLTRKfcpC5UvUT3KAlXU9w+kQMDNaB52TDQ8GluVJxcTIVAb2doCqxdTolXTWrcvFo7w6+EJOfWUfmz9gFnG5LtmRAdWGa0yq5Gh0NCWcyb34oo/8qmrsssTrcNRkUbJg8NGFVzT6m3vrOypiHI0WTwSPeMUtb0/GuWNUV40hG5L/QVywR/qw5e3GQrRr5VUVY25z6OtlnEeF5noj6X/MZvOfvvXZT3w8hY9DbHPwCJa76wcwxQBPQkeFMshntn+w4c9HJNqb4h07EC5COdabOcKgg1ErOoTRDG2OjeIer/cFG8cqpGJbX68JZkxY5smQr/TMihL/hsktLIdxfdmltbgzNHnkpMaaR9N6vcpzJTU8G2nEZAaq2gJwykwXr02pnGcyTTAkXfnsREqeTepAZ4yRL6i55MwGTeS3x3z+YwEievOgmI2vpN5Xo/s3pSv0iuyYc87dtytl7xXD4bj0FdxKa3EEz/eWzjgrsk7hY6Tbb9nZrYZTgTXCPXkzXf0eEaCpmUbKwzh43Vq4eUV5lG03wXHdjHcp/cVEcPWgP3M0vCPpA85pR5IkVB9otR2VnVSBZEYQ8piyROKX/EgUdbQ56TODgDw1Qv3DcZWN8YMM1gYMecQxsq0nSrrmpLlOP24XMv6TSA7SInetNUraMURhEE8hKjSzGBUtW5XIXVcEau080najJ9TXbc+dVvSxB8o8nMOyzU9B4bO6dQg5wQShycqToLLJEvaTpILtToYTgeeLLmz1WeHYsFb6X3nqKujQE9Ve8DCI4vNKPe6+U5rveNVuO6TXxEB+4H0G4hzpO127agq6DzLEK0hNBSumKXjk9fdgnlvlp6jXfrPGpnOU01hqN+Nv0G8SFnIiK8w1VCyvWwzz3Wf9MxaUwmtxebTsiJB1DBD2AbnDzomZKtosw+xcuDelr8sljPY2jWZCx6lLlDGA70LLe+pOMo/ckgPKvBvj9ZMxC5G3qW31nrgKP+6gdywbm9A44fKmvZ2lrzWSfYe8Zkwc8JRcx+lEmUDR8Ykfuc6Selr7lpT+7U4DYZ2fNX9Z0x/GCdzI2Sz2ABHdW9nckEUnvnyTWAJaAgodTYZzGBwtO6qn8rQE9JU0IwBFxNwrkGvQYv/TOPeJwFeCbEe2+AB2SQctEEwPMVwAsvCXh6cvRexh3W9nggaW469UkVuIjitK4scryqXXgqvtmH6JNs9HGW5mjflvFprnMWjqWE3wBa6CLwdO1zFp0kXeB34cnpZulOdaxEXUZGLejCHnDqxSHJyzK3YBvOY7wVDgVQybIH9rkwFChd2a5/SRTS073fZ1d2o14zOEM2FD3eU+EFNdF+JwEQXiK7B699+OKEAxbvK7fX/IqL0D/7zNyeWhzQFppRjfXc7W3JfmeFaq/9nSr0bMcsqI8dIhm+l2Aeq2B5dvdPOWjlBFboXUDXEdIYOH9HTOs++K230BytFCc3xYxu0scRRy9Pi1Xm6LO4UHeNq5YBR2bxDW06SFlo3InNc4Rkeg/6xOaMm26/5Idu0BjoghxIBvtKa5ZwLq7SoIF0y/FbFXEyFN3E2zJrGlqJIWuWiRydOSXX/UE4YYZEHbnKtx396biPkXIbbYBOEQrkOpZjI9e3HcenHxQRsW0LBXQ49HwP+PBYN+zoujJAl6krI1PdsSizlAnZk+qlaBLW//tQuSSUf2Vh8UMrhJ0/WVgCFrGE7Z93qrC8kRvj6xbqoe67r+Fpv28NR4f15jb855hi6Q9RgS6wPLePlQGkohJ0ROVUSblcQEsv25/vr6e3/5ME+On/</diagram></mxfile>
Loading
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<mxfile userAgent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36" version="7.5.6" editor="www.draw.io" type="device"><diagram id="85c8b475-6ce0-8bdd-5570-6e3425adb106" name="Page-1">7VzrU+M4Ev9rUjdzVUk5cV58hAAzU7VbOwXszd5HxVZiHbLltWUg+9df62n5ETDgkBlmqAJiWc9+/LrVamXgr+KHTxlKo99ZiOlg4oUPA/98MJmMJ4sl/BMlO1Uy931VsM1IqCuVBdfkH6wLPV1akBDnlYqcMcpJWi0MWJLggFfKUJax+2q1DaPVUVO0xY2C6wDRZuk3EvJIlS5nXln+GZNtZEYee/rNGgW324wViR5vMPE38ke9jpHpS9fPIxSye6fIvxj4q4wxrj7FDytMBW0N2VS7yz1v7bwznPAuDWaaL3eIFthMWU6M7wwx5HKwaOAN/LP7iHB8naJAvL0H9kNZxGMKT2P4GKI8knXFQ84zdotXjLJMduV78gfebFjCNdvHU3hGlGwTeAhg3hgqnzUXotd2hzOOH5wivbBPmMWYZzuoot9OTlQLLYMnhnv3JUf9uS6LXG4a5iAtRVvbdUlJ+KCJ2U7YSc90PS4pfa9Cyrk/a5Byvpg3SQlEfz0p20R0TrmgD8x6vhWfVpSI1ely6LF8ZQrTat1c0CRjdwA0Yn6JGFAQbCM4ICAjg7/4gWco4CTZwsPl5y9X8O9qCn8ynLMiC3A+goebCO9k85yjhBPERQcXqinLcgleAtQwFxCw+uP8Qo29IRTYbzu2fQ4mK4GdeEMSNTKPRI+5bM821aoeukOEojUtZy0Xc5qmZmC9CjHVbxEJovrsQDLgb5HLyZBcfR4GKFeUCRXQbsi2yBAnDHqfo1jIZ7LOU4fCeSpGVkTOUxyQDQkclriv25qM9vW7py0Up3uZfCNJZoitlyvn7l1mKMb3LLstJUBSAX7PYM1GlLx7TasMb0kOkmEqAWNQQUUNCuWGJbhCUUk0XSQKQsRF003GYvFayneFB5LbigGJHqdGc0+Iixa3LktDNGe1FSamnV0jjxCvL1FOznSvJ17OddSJ/G38NWXrrIWTTzO4hp6AXPwxiExYggU6EkprRTBUIPTKP5+VTzcMJO58ONkHxQzAckOlqY5IGGJA2LMqgPcBs1WLNZm2WKxpi8Wa9GGxph1g1hXZLlBbEfFC4sl4NBr9G/6D01hQXAPHBGT9DtPd0AW1qu7coYywwtEpBwm51pwII8qF6uY7kOrYQbF4DVpWyr3uQs4gZWlBFXZDm1R8zC2kOmj9AY+2oxYg/9iC5I9B2n7l+RKnLBOmhO6UKahgS6BsFcwQx0qJYVnw8CDmQlJMYYV5aSj+LnDOpZm61CYNidqqY2lYngbzFUoCnJ2THAM+XnPEJf3trBRoCKf7eQDuloFw1C2lNmZSqbjGKwuOnMR4mGKQhVAqCI9YISoou7NTdlMoLQjTNkMJsDaT7aHX2CDqB9kdj4iia66pgsKQiBqINloErKAKpANaKM/BDiqMnQBt1Vh3VbcSCfSQKKRtex8A90ggB04YL9VD09qqwcrKtAR5lnwcPQtM98B1KzT/XBg8HVd93bZdg8Hp3jF41gGDLXB2AmAkXZhYtoEPt4lUUy8CKmrR4ojems8scQBXYZgVtAj+yT5y4MzQEXmBMSSTYJSLlUolAEFARHnZUnG2OAFlNdVxrhUcFCt3MLXaUIN0jG7FsIBAHEmFBf6Cm6PdFT16aAHDYrBCPqEYnpVvQ5fzmu2wtFyXpLTjW0uloNclmAbjEg3E48Xnq3+J6vd4LcbA2R2xXr0YdXX9n4Fy58qyENYQGJO0Vq43Zey2SFUduTQGeJ1VujTunVj+etc0ffvctZ9Qkf2TcTdNHs8nr9fkeQdNvindjC66/Gdestl1rKQhdzyWcler9408KwJeyE2eNDKqGJwU2MUgaVaf3IxWzOqGYBpa07TGSphpOTvQBxarukKc5abFmaBSGt3loNxo2X7VhtTRbCX9qTHKckZFKrykytZcL0M6h2BUYRrabK8xv8c4qXSiYc0ZBZqDRwGuxjM3Ob+sJijbuLp1mXc0m+NpD2Zz0VC2PwWA1uiOwy04r+oRJCdiWyEIF2VpjSwOg/6HOd/pIBsqQOyBrLaH35jkgKhXj8Xtpay2rSqsrIo4yoTfq0OQqkxM+VHyZ5jKLVOl89eQctkgZSVg0FtoWDx8RRyMeCJLYGPYUIQ3DxjXw5zLZpjzpEWG5z2I8Ek73Qf7Azy9oUqDlIJiYhNyql/EABtSP9oY3IGrdd7JZz3zSR98M6cYj4SnLYVdxvk9MM54GQ7nPsntq3IxlT0IyZ0xB5dy/2bNhPOmT8DCD4T/5Xz+r6gymh0aygxuVbBsdiwsMzbJYc0llpZeu/9fEuHB9E91RWlDd/kmgbn/pVvIh2NyZH40jjSPxVxP9l1bF//keNZl3OGY9yBoU8r9aDaZVWV/PJmagq84I3JHr/s+rErMWlRi0bdK6KZfGZE7LC0Ei+V45Ds/s4pILCde21vTvZqw7rHGfDvFbvLQDPb/LqMsDXN1pcMoLa9u2D471sm6NR0W2HOSf2TQX0lBymQgCGrPzgaz82e5KhStMT2z2RiO0ut8jE7CY9SmruQ280TPduBmb7Qp/xAYO51Xj3d056+UKOOx606ny2oHbLOR58avE5dmXNJGId81Zs+WR8TsZgjJCaL8VGRfjpvRhIORvRlMqAeL64aTUpLmMj4ToVQUBpQV4dN8OC6RF7X46NJrEtmmQlVCNl4PST3jZqDhEB6JN1q4rrj1vt131iM5ii9+tEjPuBlyaByTmAKx3Apv5n8XzLwY5pIQpwI6lulD+dL08mSqyorFKUvk+ZHs5lymPomKZTLNlVw/lEQiCbR0MdTUGp7H+gDh19cFSjqLzPPzRRyNnXotGtsHLhr9fPxEgzHa8TTjBQla7rG8Hsmc0akjhbWTxyYOIp7ObDhNK8L0VJZCvUuVOIIzcZJZnyFH+e1rMiLWGHotj1/RhsuzP2wp9dSJ/2MTV9R3Dg8NPXVGRCfelMeem0IdtYCGcCGfki45VhOXKRuApTF4LqIAx4hIydrIt7vKosRDlqlMFxYERWYJ0DqGaCamEqrEHVVT5IYMKmddFMkD57wIwIDnm4LWCemdVlinieFIlUMqNYgjZjqzSSdMOifjQrqel5fRG1Z9v0dFfm3D0pZgMR23uB2LRQ8o1gyEaMl/1w51/WSjzaEeH8py+M0IeZ+u3kFdNpMV6bpsy749Ntn0NMvQzqmggx/7I0lVji70Hv3yRdXhgxr/pRECvxlqV6cg6mS+JazUTL1pCSG97NzkB4gsWZ14dWTJG3n+XDd9aSip12CR3+Yovr267z+L6Q0IjDE5MhLUzhWW1Stfr1ftpsn8aj1e2LnF8kJIXV3B9aGgPtqlu1G+sPeNiNy0d6PERtL7UOLJtBodfqVKm7izifTrXofmGLxXlW+5O1Dhf1M6OgrB+/LCpscLJnfKLHZ41nETX23hfRAbno92QyRy+ofOxunZl8jUTmv12xex+mxb6BTjZ+x6TXqtsykzqUxlCr2TE2jDCtWk+9arf6rrzpORQzmxAsF4xaTy7peIGQzUdQa5d2U5ro1oMqWLlDIkm0TygovaDcvN7pfV6dWFzuEmySZDTgKoWPR9RjiutQyJGFjeNeHB6GMfdwnchl2CPU7qqr2spi8xqhiPzvjM7UIrUQO52y8vB5mxFIc1/zRRMDXJ6s4dk5IJ7n0MffPEZMGiO/dCpsqgzV0a/trtP455rZv9thttXh+gt+zT8SwdyskjRwqTFx8pdHNDW44QTNnbHyFM244QvhdXv82qd6Kx/+O4+vN+Xf1ZM1Lzh7aNdG843fHfDrIveC+7BassfSSTeCfzmmPfTzaJOf02afw1FO5ltzBrxop6xeljpVq24YZ/tFTLWTMM8ysi9whDZ/tcm5ds5k3ujlHOaS/KOay16Cdc99y9e1dIfquvt+mw7e/Bj619NcPYa8mWOdTmfdpMSTqmm9XM8n0ZXM6bcNl/NsyL3Cz7tVCW2/Wv0XqiwcLv2TFrZku13XD7AWDWynIfMDudV8+Sh5NecdY4QYdIqfWb2Z1u3EZdEe/j1t13j6z1s+lWaD3Y4fSsGRiVmuWtVDbHdRk4dMNWT26FWmzos32kn+YCXy3d98T4ru79veWkKQB93N+btd3U7z9q9MjVGLtpeaN9irkt6RreWe/xjT30h8fy2y0VbpZfIepf/B8=</diagram></mxfile>

0 commit comments

Comments
 (0)