Merge pull request #2496 from myk002/myk_arch_diagrams

add arch diagrams to the dev guide
develop
Myk 2022-12-12 14:54:26 -08:00 committed by GitHub
commit 945942a28b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 0 deletions

@ -41,6 +41,7 @@ changelog.txt uses a syntax similar to RST, with a few special sequences:
## Documentation ## Documentation
- `overlay-dev-guide`: added troubleshooting tips and common development workflows - `overlay-dev-guide`: added troubleshooting tips and common development workflows
- added DFHack architecture diagrams to the dev intro
## API ## API

@ -16,6 +16,22 @@ Other pages that may be relevant include:
.. contents:: Contents .. contents:: Contents
:local: :local:
Architecture diagrams
---------------------
These two diagrams give a very high level overview of where DFHack injects
itself in the DF call structure and how the pieces of DFHack itself fit
together:
.. image:: https://drive.google.com/uc?export=download&id=1-2yeNMC7WHgMfZ9iQsDQ0dEbLukd_xyU
:alt: DFHack logic injection diagram
:target: https://drive.google.com/file/d/1-2yeNMC7WHgMfZ9iQsDQ0dEbLukd_xyU
:align: center
.. image:: https://drive.google.com/uc?export=download&id=1--JoEQbzKpVUOkRKDD9HxvuCqtom780F
:alt: DFHack tool call graph
:target: https://drive.google.com/file/d/1--JoEQbzKpVUOkRKDD9HxvuCqtom780F
:align: center
Plugins Plugins
------- -------