Skip to content

docs: animated architecture diagrams (SVG, brand style) - #2

Merged
sayed3li97 merged 2 commits into
mainfrom
docs/architecture-diagrams
Jul 6, 2026
Merged

docs: animated architecture diagrams (SVG, brand style)#2
sayed3li97 merged 2 commits into
mainfrom
docs/architecture-diagrams

Conversation

@sayed3li97

Copy link
Copy Markdown
Owner

Five animated explanatory diagrams in the dark / monospace / blue-accent house style, matching the diagrams on sayedalialkamel.com. Docs/assets only — no code change.

Diagrams (doc/diagrams/)

File Explains
architecture-ffi-flow.svg A camera frame's path across the one Dart ↔ native FFI hop
capability-passport-tier.svg Supported/NotSupported → Full / Standard / Basic
visual-aids-pipeline.svg GPU/CPU dispatch → the five live overlays
digital-controls.svg The "no sensor controls → still CameraTier.full" trick
web-puredart-split.svg The conditional export that keeps dart:ffi/dart:io off web

Wiring

  • Gallery page: doc/diagrams/README.md.
  • Hero diagram embedded in the main README ("Architecture at a glance") and at the top of ARCHITECTURE.md.
  • All five are self-contained, dependency-free SVG (~32 KB total), well-formed (xmllint), and degrade gracefully — nodes stay visible when CSS animation is stripped, so they don't vanish on renderers like pub.dev; they animate on GitHub.
  • .pubignore now excludes doc/ (diagrams + screenshots are GitHub-facing; pub.dev resolves README images from the repo). Archive stays ~376 KB.

Notes

  • pub.dev: SVGs may show a static frame rather than animate. If you want the diagrams to animate on the pub.dev page too, I can export GIF copies as a follow-up.
  • Separate from PR docs: post-0.0.1 polish — pub badge, roadmap refresh, changelog #1 (post-0.0.1 docs polish); no file overlap beyond distinct README sections, so both merge cleanly.

🤖 Generated with Claude Code

SayedAliAlkamel and others added 2 commits July 6, 2026 00:40
Five self-contained, dependency-free animated SVG diagrams in the dark /
monospace / blue-accent house style, explaining how camera_pro works:

- architecture-ffi-flow      — a frame's path across the one Dart↔native FFI hop
- capability-passport-tier   — Supported/NotSupported → Full/Standard/Basic
- visual-aids-pipeline       — GPU/CPU dispatch → the five overlays
- digital-controls           — the "no sensor controls → still DSLR" trick
- web-puredart-split         — the conditional export that keeps dart:ffi off web

- Gallery: doc/diagrams/README.md. Hero diagram embedded in the main README
  ("Architecture at a glance") and ARCHITECTURE.md.
- SVGs degrade gracefully: nodes are visible without CSS animation (fill-mode
  both, no base opacity:0), so renderers that strip animation still show the
  full diagram. They animate on GitHub.
- .pubignore now excludes doc/ entirely (diagrams + screenshots are
  GitHub-facing; pub.dev resolves README images from the repo). Archive stays
  ~376 KB.

Docs/assets only — no code change.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…ool)

Same house style, extending the set to ten:
- capture-paths      — capturePhoto → PNG / linear-DNG (EXIF) / video
- simd-arch          — NEON · SSSE3 · scalar, bit-exact (+ the honest bench)
- burst-bracket      — captureBurst(5) ≈1.2s and −2/0/+2 EV with measured YAVG
- ci-matrix          — native.yml across macOS / Ubuntu / Windows / web, green
- buffer-pool-ring   — the lock-free, cache-aligned, GC-free frame ring

All self-contained SVG, well-formed (xmllint), graceful-degrading (visible
without CSS animation), added to the doc/diagrams gallery. Docs/assets only.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@sayed3li97
sayed3li97 merged commit 388a4a7 into main Jul 6, 2026
4 checks passed
sayed3li97 pushed a commit that referenced this pull request Jul 6, 2026
Builds on the hero (architecture-ffi-flow) already on main from #2 and places
the other nine at the section each explains, turning the README into a visual
tour — all in the dark / monospace / blue-accent house style:

- Feature status (intro)  → capability-passport-tier
- Manual controls         → digital-controls
- Visual aids             → visual-aids-pipeline
- Capture                 → capture-paths + burst-bracket
- Web                     → web-puredart-split
- Verified this build     → ci-matrix
- Measured performance    → simd-arch + buffer-pool-ring

README-only (+47). The SVGs already landed on main via #2; this just embeds
them. Rebased onto current main after #1/#2 merged, so it applies cleanly.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants