docs: add architecture reference documentation

[2024itb047samata]

Summary

Adds a dedicated architecture reference document for the completed 4-phase Eagle pipeline.

Changes

• Added docs/ARCHITECTURE.md
• Documented:
  • Full pipeline overview
  • Component/service table
  • Mermaid data-flow diagram
  • Key design decisions
  • Explicit non-goals / out-of-scope items
• Updated README.md
  • Removed placeholder ASCII architecture block
  • Added lightweight architecture overview
  • Linked to the new architecture reference doc

Notes

• References actual repository paths and modules
• Mermaid diagram renders in GitHub Markdown preview
• Keeps README concise while moving detailed architecture into docs

closes #115

Summary by CodeRabbit

• Documentation
  • Updated System Architecture section in README with reference to comprehensive architecture documentation.
  • Added detailed architecture reference guide with component overview and data-flow diagram describing the event-driven surveillance pipeline and system integration.

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR replaces a static ASCII architecture diagram in the README with a dedicated docs/ARCHITECTURE.md reference document. The new documentation describes the full event-driven surveillance pipeline (frame ingestion, detection, tracking, Redis memory, VLM/LLM reasoning stages) and includes a component overview table and Mermaid data-flow diagram. The README is updated to link to this documentation and list key pipeline components.

Changes

Architecture Documentation

Layer / File(s)	Summary
System Architecture Reference docs/ARCHITECTURE.md, README.md	docs/ARCHITECTURE.md added with pipeline overview, component service table (detection, tracking, temporal memory, VLM/LLM reasoning, FastAPI backend, Next.js frontend), and end-to-end data-flow diagram. README "System Architecture" section replaced with link to the new doc and bullet-point summary of key architecture components.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A doc-garden grows so neat,
Where pipelines flow from frame to feat,
From Redis rings to reasoned sight,
The Eagle's map now shines so bright! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title 'docs: add architecture reference documentation' is clear, concise, and directly describes the main change: adding new architecture documentation.
Linked Issues check	✅ Passed	The PR addresses all coding requirements from issue #115: adds docs/ARCHITECTURE.md with pipeline overview, component table, Mermaid data-flow diagram, key design decisions, and out-of-scope items; updates README.md to link to the new doc; and maintains a concise reference format.
Out of Scope Changes check	✅ Passed	All changes are directly aligned with issue #115 requirements: documentation updates to README.md and creation of docs/ARCHITECTURE.md with specified sections.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/ARCHITECTURE.md`:
- Around line 23-41: The Mermaid code block opens with ```mermaid but is closed
with four backticks; change the closing fence to exactly three backticks so the
block properly closes (ensure the sequence that ends the diagram is ``` not
````), leaving the Mermaid header (```mermaid) and the diagram contents
(flowchart TD ... Next.js Dashboard) intact.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e357efa2-0119-4bc0-9597-9a17409fae96

📥 Commits

Reviewing files that changed from the base of the PR and between 3c9175c and ad1e5f4.

📒 Files selected for processing (2)

• README.md
• docs/ARCHITECTURE.md