Updating packet diagram animations#219
Conversation
|
| Filename | Overview |
|---|---|
| .github/workflows/docs.yml | Adds docs/images/packet_diagrams/** trigger, pins Python to 3.12, installs Pillow, and runs make all before mkdocs build so WebP/GIF animations are present when the docs site is assembled. |
| .gitignore | Adds gitignore entries for WebP/GIF outputs under each packet-diagram subdirectory; the pre-existing duplicate __pycache__/ line is harmless and pre-dates this PR. |
| docs/images/packet_diagrams/Makefile | Splits outputs into ANIMATIONS (WebP+GIF, gitignored, existence-checked) and POSTERS (committed PNG, git-diff-checked). check and clean targets updated accordingly; Python auto-detection added for WebP-capable interpreter. |
| docs/images/packet_diagrams/anim_common.py | Adds shared canvas constants, a single _BASE color dict with diagram_colors() factory, output_paths() helper, and a full GIF encoder (_build_gif_palette / rgba_to_gif_frame / save_gif_animation) that handles transparency via index 255. |
| docs/images/packet_diagrams/flow_steering_animation.py | Drops multi-theme support; adds host queue 4 alongside three GPU queues; uses shared constants and draw_incoming_wire; frames saved at 2x resolution. |
| docs/images/packet_diagrams/hds_animation.py | Removes multi-theme and per-theme globals; switches to shared constants, diagram_colors(), and draw_incoming_wire; route arrows now use shared line width constants. |
| docs/images/packet_diagrams/incoming_wire.py | Refactors draw_rx_wire_label to take ImageDraw/ImageFont directly; adds draw_incoming_wire convenience wrapper; animate_markers default changed from False to True. |
| docs/images/packet_diagrams/reorder_animation.py | Drops multi-theme; fixes CONVERT_STAGING_COL / CONVERT_QUEUE_COL to match the reorder columns; uses shared constants throughout. |
| docs/stylesheets/extra.css | Adds .packet-diagram img rule so embedded WebP animations scale to the column width. |
| docs/tutorials/configuration-walkthrough.md | Embeds flow-steering, HDS, reorder, and reorder-quantize WebP animations; adds cross-reference from the decision tree to the new flow-steering section. |
| docs/concepts.md | Embeds HDS, flow-steering, and GPU reorder WebP animations into the relevant concept sections. |
| docs/images/packet_diagrams/README.md | Updates requirements, check workflow, and per-generator output description to reflect the new WebP+GIF+PNG model and gitignored animations. |
Reviews (2): Last reviewed commit: "#159 - Refresh packet diagram animations..." | Re-trigger Greptile
2e96fea to
27f013c
Compare
Single-theme transparent diagrams for slides, shared incoming-wire rendering, gitignored WebP/GIF with CI generation, and updated docs embeds. Signed-off-by: Chloe Crozier <chloecrozier@gmail.com>
27f013c to
2d4c6ac
Compare
|
@RamyaGuru, I added the changed you suggested offline! |
Changes
Follow-up to #159 (merged PR adding HDS, flow steering, and reorder docs animations).
Testing
make -C docs/images/packet_diagrams check