From 8750f7b6d85b1abd6576da54e98810aba5ead223 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20Qui=C3=B1ones?= Date: Wed, 29 Jan 2025 12:23:28 -0300 Subject: [PATCH 1/3] Update technical documentation Document BlockDefinition resource and block types using GDScript documentation comments. Outside code, rename the current technical document to `docs/TECH_OVERVIEW.md` to indicate that it's technical. And update it: - Move "How to create a new block" to the top - Leave UI technical docs in its own section - Remove other outdated explanation It would be nice to also document the AST decouple from the UI, but I'm no expert to do it. --- .../code_generation/block_definition.gd | 40 ++++++- addons/block_code/types/types.gd | 10 +- docs/OVERVIEW.md | 108 ------------------ docs/TECH_OVERVIEW.md | 26 +++++ 4 files changed, 68 insertions(+), 116 deletions(-) delete mode 100644 docs/OVERVIEW.md create mode 100644 docs/TECH_OVERVIEW.md diff --git a/addons/block_code/code_generation/block_definition.gd b/addons/block_code/code_generation/block_definition.gd index a4447044..d13ce8bf 100644 --- a/addons/block_code/code_generation/block_definition.gd +++ b/addons/block_code/code_generation/block_definition.gd @@ -11,25 +11,59 @@ const FORMAT_STRING_PATTERN = "\\[(?[^\\]]+)\\]|\\{const (?