Table of Contents

• 🖼️ Assets
• Conventions

🖼️ Assets

Static assets referenced by the docs: diagrams (exported), screenshots, GIFs, and the social/preview image.

assets/
└── img/      diagrams, screenshots, badges

Conventions

• Prefer inline mermaid in markdown over static images where possible (renders + diffs on GitHub).
• For screenshots/GIFs of running projects, use descriptive names: crawler-demo.gif, bookstore-architecture.png.
• Always provide alt text: ![Bookstore architecture](assets/img/bookstore-architecture.png).
• Keep images reasonably sized (compress GIFs; <2 MB where possible).

---

⬅ README