From d74d215f38dd27d60927e6965fa2fdb3ec704791 Mon Sep 17 00:00:00 2001 From: Myk Taylor Date: Sun, 11 Dec 2022 15:51:27 -0800 Subject: [PATCH] add arch diagrams to the dev guide --- docs/changelog.txt | 1 + docs/dev/Dev-intro.rst | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) diff --git a/docs/changelog.txt b/docs/changelog.txt index 6d68f7586..590734864 100644 --- a/docs/changelog.txt +++ b/docs/changelog.txt @@ -41,6 +41,7 @@ changelog.txt uses a syntax similar to RST, with a few special sequences: ## Documentation - `overlay-dev-guide`: added troubleshooting tips and common development workflows +- added DFHack architecture diagrams to the dev intro ## API diff --git a/docs/dev/Dev-intro.rst b/docs/dev/Dev-intro.rst index a49cb96f6..25861862e 100644 --- a/docs/dev/Dev-intro.rst +++ b/docs/dev/Dev-intro.rst @@ -16,6 +16,22 @@ Other pages that may be relevant include: .. contents:: Contents :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 -------