Skip to content

docs: add comprehensive system architecture documentation - #3125

Open
amirbiron wants to merge 1 commit into
mainfrom
claude/create-system-diagram-t2aCP
Open

docs: add comprehensive system architecture documentation#3125
amirbiron wants to merge 1 commit into
mainfrom
claude/create-system-diagram-t2aCP

Conversation

@amirbiron

Copy link
Copy Markdown
Owner

✨ תיאור קצר

הוספת תיעוד ארכיטקטורה מקיף המתאר את מבנה המערכת, זרימת הנתונים, ערימת Docker Compose, וטכנולוגיות עיקריות. התיעוד כולל דיאגרמות Mermaid ויזואליות לעזרת מפתחים וחברי צוות בהבנת המערכת.

📦 שינויים עיקריים

  • תיעוד (docs/)

פירוט:

  • הוספת קובץ docs/architecture/system-overview.md עם:
    • דיאגרמת ארכיטקטורה כללית (Mermaid graph) המציגה את כל שכבות המערכת:
      • שכבת לקוחות (Telegram, Web Browser)
      • שכבת Telegram Bot (handlers, conversation flows)
      • שכבת Flask WebApp (routes, APIs, templates)
      • שכבת Services (core, integration, search, backup)
      • שכבת Domain (entities, services, interfaces)
      • שכבת Database (MongoDB, Redis)
      • שירותים חיצוניים (GitHub, Google Drive, Pastebin)
      • Observability Stack (Sentry, Prometheus, Grafana, Jaeger)
      • Infrastructure (Docker, Nginx, Gunicorn, CI/CD)
    • דיאגרמת זרימת נתונים (sequence diagram) המציגה:
      • זרימת שמירת קוד דרך Telegram
      • זרימת צפייה בדשבורד דרך WebApp
      • זרימת גיבוי ל-GitHub
    • דיאגרמת Docker Compose המציגה את הקונטיינרים והחיבורים
    • טבלת טכנולוגיות עיקריות לפי שכבה

🧪 בדיקות

  • N/A - שינוי תיעוד בלבד, ללא קוד או בדיקות

📝 סוג שינוי

  • docs: שינוי תיעוד בלבד

✅ צ'קליסט

  • אין קוד חדש שדורש בדיקות
  • תיעוד עודכן (הוספת קובץ ארכיטקטורה חדש)
  • אין סודות/מפתחות בקוד
  • הודעת הקומיט תואמת Conventional Commits

🧩 השפעות/סיכונים

  • אין השפעה על קוד, בדיקות, או פרודקשן
  • זהו תיעוד עזר למפתחים

🔗 קישורים

https://claude.ai/code/session_01GuvLqKFEXaDTAqiBEXuF4d

תרשים Mermaid מקיף שמכסה את כל שכבות המערכת:
- שכבת Bot (Telegram), WebApp (Flask), Services, Domain, Database
- זרימת נתונים עיקרית (Sequence Diagram)
- מבנה Docker Compose
- טבלת טכנולוגיות

https://claude.ai/code/session_01GuvLqKFEXaDTAqiBEXuF4d
@github-actions

Copy link
Copy Markdown

🧯 Dangerous deletes guard report

Policy: see .cursorrules — dangerous deletions are blocked unless wrapped safely.

Summary:

  • Flagged findings (blocking): 0
    0
  • Excluded matches (not blocking): 15
  • Total matches (all files): 129

Flagged findings (file:line:snippet):
(none)

Excluded matches (by path pattern)
./webapp/static/js/md_preview.bundle.js.map:4:  "sourcesContent": ["// Markdown-it plugin to render GitHub-style task lists; see\n//\n// https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments\n// https://github.com/blog/1825-t … [truncated]
./README.md:842:find . -name "__pycache__" -exec rm -rf {} +
./node_modules/mermaid/dist/mermaid.min.js:1524:`,"getStyles"),c1e=RQe});var h1e={};dr(h1e,{diagram:()=>NQe});var NQe,f1e=N(()=>{"use strict";$ge();a1e();l1e();u1e();NQe={parser:Fge,db:n1e,renderer:o1e,styles:c1e}});var m1e,g1e=N(()=>{"use  … [truncated]
./node_modules/mermaid/dist/chunks/mermaid.esm.min/chunk-4HFYJGYH.mjs:1:var r={name:"mermaid",version:"11.12.0",description:"Markdown-ish syntax for generating flowcharts, mindmaps, sequence diagrams, class diagrams, gantt charts, git graph … [truncated]
./node_modules/mermaid/dist/chunks/mermaid.esm.min/chunk-4HFYJGYH.mjs.map:4:  "sourcesContent": ["{\n  \"name\": \"mermaid\",\n  \"version\": \"11.12.0\",\n  \"description\": \"Markdown-ish syntax for generating flowcharts, mindmaps, sequen … [truncated]
./node_modules/mermaid/dist/chunks/mermaid.esm/chunk-2M32CCKP.mjs.map:4:  "sourcesContent": ["{\n  \"name\": \"mermaid\",\n  \"version\": \"11.12.0\",\n  \"description\": \"Markdown-ish syntax for generating flowcharts, mindmaps, sequence d … [truncated]
./node_modules/mermaid/dist/chunks/mermaid.core/chunk-KS23V3DP.mjs.map:4:  "sourcesContent": ["{\n  \"name\": \"mermaid\",\n  \"version\": \"11.12.0\",\n  \"description\": \"Markdown-ish syntax for generating flowcharts, mindmaps, sequence  … [truncated]
./node_modules/mermaid/dist/mermaid.js.map:4:  "sourcesContent": ["/**\n* Default values for dimensions\n*/\nconst defaultIconDimensions = Object.freeze({\n\tleft: 0,\n\ttop: 0,\n\twidth: 16,\n\theight: 16\n});\n/**\n* Default values for tr … [truncated]
./node_modules/mermaid/dist/mermaid.min.js.map:4:  "sourcesContent": ["/**\n* Default values for dimensions\n*/\nconst defaultIconDimensions = Object.freeze({\n\tleft: 0,\n\ttop: 0,\n\twidth: 16,\n\theight: 16\n});\n/**\n* Default values fo … [truncated]
./node_modules/katex/package.json:153:    "build": "rimraf dist/ && mkdirp dist && cp README.md dist && rollup -c --failAfterWarnings && webpack && node update-sri.js package dist/README.md",
./node_modules/katex/src/fonts/Makefile:139:	rm -rf pfa ff otf ttf woff woff2
./docs/Makefile:24:	rm -rf $(BUILDDIR)
./docs/DOCUMENTATION_GUIDE.md:453:rm -rf _build
./Dockerfile:42:    rm -rf /var/lib/apt/lists/*
./Dockerfile:121:    rm -rf /var/lib/apt/lists/*

@github-actions

Copy link
Copy Markdown

⏱️ Performance report

(No performance test durations collected. Mark tests with @pytest.mark.performance.)

@github-actions

Copy link
Copy Markdown

📖 Documentation Preview

The documentation has been built successfully!

To view locally:

  1. Download the artifacts
  2. Extract the zip file
  3. Open index.html in your browser

@sentry

sentry Bot commented Mar 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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