Enhance core documentation with diagrams and animated illustrations

[rootsongjc]

Summary

Several core documentation pages lack visual explanations, making them harder to understand than necessary. Adding diagrams, illustrations, and GIFs would significantly improve the documentation quality.

Inspiration

@mesutoezdil created an excellent visual explanation for the Local Fake GPU lab and shared it on LinkedIn. This kind of concrete, visual content makes concepts much more accessible. We should apply this approach to more documentation pages.

Pages Needing Enhancement

The following pages are written too simply and need richer visual content:

1. Architecture

• Add a high-level architecture diagram showing HAMi components (scheduler, device plugin, webhook, etc.) and their interactions
• Show the request flow from Pod submission → scheduling → GPU allocation

2. Device Sharing

• Illustrate how a single GPU is shared among multiple pods/containers
• Show the difference between GPU sharing with and without HAMi
• Diagram of time-slicing vs. MPS vs. HAMi approaches

3. Device Resource Isolation

• Visual explanation of resource isolation mechanisms
• Show how memory/compute resources are partitioned
• Animated GIF demonstrating isolation behavior under load

Proposal

1. Create high-quality diagrams (SVG preferred for scalability) for each page listed above
2. Consider animated GIFs for dynamic concepts (e.g., scheduling flow, resource allocation)
3. Rewrite accompanying text to be more thorough — current docs are too brief for a mature project
4. These assets can also be reused in blog posts, presentations, and books

Collaboration

@maishivamhoo123 has expressed similar interest in creating diagrams and GIFs that can also serve blog posts and book writing.

References

• Mesut's LinkedIn post with excellent visual example: https://www.linkedin.com/feed/update/urn:li:activity:7470381993524871169/
• Local Fake GPU Lab: https://project-hami.io/tutorials/labs/local-fake-gpu

/cc @mesutoezdil @maishivamhoo123

[maishivamhoo123]

@mesutoezdil, this post (https://www.linkedin.com/feed/update/urn:li:activity:7470381993524871169/) is really great. I think adding GIFs and animations like this would be very helpful and make the documentation easier to understand, especially on these pages:
https://project-hami.io/docs/core-concepts/gpu-virtualization#hami-virtual-gpu-scheduling-principles
https://project-hami.io/docs/core-concepts/architecture
https://project-hami.io/docs/core-concepts/gpu-stack

and other pages in the Core Concepts section as well.

[mesutoezdil]

This connects to the diagram redraw work tracked in #421 and the inventory at docs/diagrams-inventory.md.

The highest-impact starting point is the architecture page. The current architect.jpg has no source file and is marked outdated in the inventory. Redrawing it as SVG with a PlantUML source (same pattern as the existing device-plugin-flow.plantuml and hami-architecture.plantuml files) would cover the first item on the list here and also close a gap in #421.

For the animated content, the Local Fake GPU lab post used screen recordings converted to GIF. The same approach works for scheduling flow demos. The output can be placed under static/img/docs/ alongside the static diagrams.

Suggested order:

1. Architecture SVG redraw (blocks [docs/diagram] Redraw all architecture diagrams as SVG with editable source files #421 item, highest reuse across blog and presentations)
2. Device sharing diagram (static SVG, one per sharing model)
3. Scheduling flow GIF (animated, records an actual HAMi allocation)

Happy to work on the architecture SVG if there is agreement on the component layout and what the diagram should show.

@rootsongjc @maishivamhoo123