Merge pull request #139 from nerdai/nerdai/adjust-to-conform-to-manning-guidelines

Author: nerdai

Makefile

@@ -20,14 +20,7 @@ coverage-report: ## Show coverage summary in terminal
 coverage-html: ## Generate HTML coverage report
 	coverage html
 
-diagrams:	## Generate UML diagrams from PlantUML files
-	@echo "Generating UML diagrams..."
-	@mkdir -p uml/rendered
-	@find uml -name "*.puml" -not -path "uml/common/*" -exec dirname {} \; | sed 's|^uml|uml/rendered|' | sort -u | xargs mkdir -p
-	@find uml -name "*.puml" -not -path "uml/common/*" -exec sh -c 'java -jar ~/plantuml.jar -SDPI=300 -o "$$(dirname "{}" | sed "s|^uml|$(PWD)/uml/rendered|")" "{}"' \;
-	@echo "Diagrams generated in uml/rendered/ directory with chapter structure!"
-
-diagrams-svg:	## Generate SVG diagrams (for web)
+diagrams:	## Generate SVG diagrams (for web)
 	@echo "Generating SVG diagrams..."
 	@mkdir -p uml/rendered
 	@find uml -name "*.puml" -not -path "uml/common/*" -exec dirname {} \; | sed 's|^uml|uml/rendered|' | sort -u | xargs mkdir -p

uml/README.md

@@ -54,26 +54,12 @@ plantuml-new -SDPI=300 uml/ch04/llm_agent_class.puml
 
 ```sh
 # Generate all diagrams using make
-make diagrams      # PNG files
-make diagrams-svg  # SVG files
+make diagrams      # SVG files
 
 # Or manually generate all files
 plantuml-new -SDPI=300 uml/**/*.puml
 ```
 
-## Directory Structure
-
-```sh
-uml/
-├── common/
-│   └── book-clean.puml     # Shared styling
-├── ch04/
-│   ├── llm_agent_class.puml
-│   └── llm_agent_sequence.puml
-└── rendered/               # Generated images
-    └── ch04/
-        ├── llm_agent_class.png
-        ├── llm_agent_class.svg
-        ├── llm_agent_sequence.png
-        └── llm_agent_sequence.svg
-```
+> [!NOTE]
+> For the book, most of these SVG images are further polished with
+> inkscape.

uml/ch01/llm_agent_build_mental_model.puml

@@ -1,10 +1,5 @@
 @startmindmap llm_agent_build_mental_model
-
-<style>
-rootNode {
-  LineThickness 2.0
-}
-</style>
+!include ../common/book-clean.puml
 
 * LLM Agent
 **_ Stage 3
@@ -19,11 +14,11 @@ rootNode {
 left side
 
 **_ Stage 1
-*** LLM
-**** Ollama
 *** Tools
 **** SimpleFunction
 **** PydanticFunction
+*** LLM
+**** Ollama
 
 **_ Stage 2
 *** MCP Tools

uml/common/book-clean.puml

@@ -1,45 +1,81 @@
-' Clean, professional theme for print
-skinparam shadowing false
-skinparam roundcorner 12
-skinparam dpi 300
+'── Book-clean theme (Manning font spec) ──────────────────────
+' You can override font families before including:
+'   !define GRAPHIC_FONT Arial
+'   !define ANNO_FONT "Humanist 521 Bold Condensed"   ' or Times
+'   !define CODE_FONT "Courier Std"
 
-' Background and borders
-skinparam backgroundcolor white
-skinparam arrowcolor #333
-skinparam linecolor #333
-skinparam arrowthickness 1.2
+!ifndef GRAPHIC_FONT
+!define GRAPHIC_FONT "Arial"
+!endif
+!ifndef ANNO_FONT
+!define ANNO_FONT "Times"
+!endif
+!ifndef CODE_FONT
+!define CODE_FONT "Courier Std"
+!endif
+
+' General look
+skinparam Shadowing false
+skinparam RoundCorner 12
+
+skinparam dpi 128
+
+' Background & borders
+skinparam BackgroundColor white
+skinparam ArrowColor #333
+skinparam LineColor  #333
+skinparam ArrowThickness 1.2
 
 ' Participants
-skinparam participantbackgroundcolor #f9fafb
-skinparam participantbordercolor #222
-skinparam participantpadding 6
+skinparam ParticipantBackgroundColor #f9fafb
+skinparam ParticipantBorderColor #222
+skinparam ParticipantPadding 6
 
 ' Lifelines
-skinparam sequencelifelinebackgroundcolor white
-
-' Notes
-skinparam noteBackgroundColor #fffbe6
-skinparam noteBorderColor #e0d97a
-skinparam noteBorderThickness 1
-
-' Fonts
-skinparam defaultfontname "Inter, Arial"
-skinparam defaultfontsize 16
-skinparam titleFontSize 20
-skinparam titleFontColor #222
-
-' Alignment
-skinparam SequenceMessageAlign center
-
-' Visibility Symbols
-skinparam classAttributeIconSize 0
-skinparam classOperationIconSize 0
-skinparam classFontName Courier
-skinparam classAttributeFontName Courier
-skinparam classFontSize 14
-
-' Stereotypes
-skinparam stereotypePosition bottom
-
-' Sequence Message Alignment
-skinparam sequenceMessageAlign reverseDirection
+skinparam SequenceLifeLineBackgroundColor white
+
+' Notes / legends (Annotations)
+skinparam NoteBackgroundColor #fffbe6
+skinparam NoteBorderColor #e0d97a
+skinparam NoteBorderThickness 1
+
+'──────────── Fonts (per Manning spec) ────────────
+' Graphic text
+skinparam DefaultFontName GRAPHIC_FONT
+skinparam DefaultFontSize 7
+skinparam ArrowFontName   GRAPHIC_FONT
+skinparam ArrowFontSize   7
+skinparam ParticipantFontName GRAPHIC_FONT
+skinparam ParticipantFontSize 7
+
+' Headings
+skinparam TitleFontName GRAPHIC_FONT
+skinparam TitleFontSize 8
+skinparam TitleFontColor #222
+' Sequence group header labels (loop/alt/opt/etc.)
+skinparam SequenceGroupFontName GRAPHIC_FONT
+skinparam SequenceGroupFontSize 8
+
+' Annotations (notes/legend)
+skinparam NoteFontName   ANNO_FONT
+skinparam NoteFontSize   9
+skinparam LegendFontName ANNO_FONT
+skinparam LegendFontSize 9
+
+' Code text (class diagrams etc.)
+skinparam ClassFontName              CODE_FONT
+skinparam ClassFontSize              8
+skinparam ClassAttributeFontName     CODE_FONT
+skinparam ClassAttributeFontSize     8
+skinparam ClassOperationFontName     CODE_FONT
+skinparam ClassOperationFontSize     8
+
+' Hide the little +/# icons next to members
+skinparam ClassAttributeIconSize 0
+skinparam ClassOperationIconSize 0
+
+' Stereotypes under the box
+skinparam StereotypePosition bottom
+
+' Sequence message alignment (one setting only)
+skinparam SequenceMessageAlign reverseDirection