docs: consolidate 53 files into 15 structured files in 3 folders
- business/ (5): club-commission, payment, ecommerce, membership, content - technical/ (5): cms-arch, ui, deployment, migration, api - overview/ (5): flowcharts, index, changelog, glossary, roadmap - Removed all old folders: backoffice, cms, deployment, docs, frontoffice, migration, ui-modernization, business (old) - Updated internal links with relative folder paths
This commit is contained in:
masoodafar-web
@@ -0,0 +1,167 @@
|
||||
# 📋 شاخص اصلی مستندات (Master Index)
|
||||
|
||||
> **فهرست کامل ۱۵ فایل مستند پروژه FourSat (کارا بازار سلامت)**
|
||||
> **تاریخ تجمیع:** اسفند ۱۴۰۴
|
||||
> **تعداد فایلهای مبدأ:** ۵۳ فایل (~۳۲,۰۰۰ خط)
|
||||
> **تعداد فایلهای نهایی:** ۱۵ فایل
|
||||
|
||||
---
|
||||
|
||||
## ساختار مستندات
|
||||
|
||||
```
|
||||
totalDoc/
|
||||
├── 📁 business/ (سطح بیزینسی — ۵ فایل)
|
||||
│ ├── BUSINESS-01-CLUB-COMMISSION.md سیستم باشگاه و کمیسیون
|
||||
│ ├── BUSINESS-02-PAYMENT-FINANCE.md مالی و درگاهها
|
||||
│ ├── BUSINESS-03-ECOMMERCE-STORES.md فروشگاه و موجودی
|
||||
│ ├── BUSINESS-04-USER-MEMBERSHIP.md چرخه کاربر و عضویت
|
||||
│ └── BUSINESS-05-CONTENT-MANAGEMENT.md محتوا و صفحات
|
||||
│
|
||||
├── 📁 technical/ (سطح فنی — ۵ فایل)
|
||||
│ ├── TECH-01-CMS-ARCHITECTURE.md معماری CMS
|
||||
│ ├── TECH-02-BACKOFFICE-FRONTOFFICE.md معماری UI
|
||||
│ ├── TECH-03-DEPLOYMENT-INFRA.md استقرار و زیرساخت
|
||||
│ ├── TECH-04-MIGRATION.md مهاجرت داده
|
||||
│ └── TECH-05-API-INTEGRATION.md API و یکپارچهسازی
|
||||
│
|
||||
└── 📁 overview/ (نمای کلان — ۵ فایل)
|
||||
├── OVERVIEW-01-FLOWCHARTS.md فلوچارتها و دیاگرامها
|
||||
├── OVERVIEW-02-INDEX.md ← همین فایل
|
||||
├── OVERVIEW-03-CHANGELOG.md تاریخچه و درصد تکمیل
|
||||
├── OVERVIEW-04-GLOSSARY.md واژهنامه و استانداردها
|
||||
└── OVERVIEW-05-ROADMAP.md نقشه راه و ریسکها
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## خلاصه هر فایل
|
||||
|
||||
### 🏆 Business Level
|
||||
|
||||
| # | فایل | موضوع | خلاصه |
|
||||
|---|------|--------|--------|
|
||||
| B1 | [BUSINESS-01-CLUB-COMMISSION](../business/BUSINESS-01-CLUB-COMMISSION.md) | باشگاه و کمیسیون | درخت باینری، فرمول ۴مرحلهای، Pool هفتگی، وام دایا، Chatika |
|
||||
| B2 | [BUSINESS-02-PAYMENT-FINANCE](../business/BUSINESS-02-PAYMENT-FINANCE.md) | مالی و پرداخت | ZarinPal IPG، ۳ کیفپول، PYMS، پرداخت ترکیبی، VAT |
|
||||
| B3 | [BUSINESS-03-ECOMMERCE-STORES](../business/BUSINESS-03-ECOMMERCE-STORES.md) | فروشگاه | Regular + Discount Store، Lazy Load، موجودی خودکار، باندل |
|
||||
| B4 | [BUSINESS-04-USER-MEMBERSHIP](../business/BUSINESS-04-USER-MEMBERSHIP.md) | کاربر و عضویت | ثبتنام OTP، قرارداد، فیچرهای باشگاه، Auth-Aware، Referral |
|
||||
| B5 | [BUSINESS-05-CONTENT-MANAGEMENT](../business/BUSINESS-05-CONTENT-MANAGEMENT.md) | محتوا | Site Pages (Shopify)، بلاگ، مدیریت فایل، SMS/Email، Landing |
|
||||
|
||||
### ⚙️ Technical Level
|
||||
|
||||
| # | فایل | موضوع | خلاصه |
|
||||
|---|------|--------|--------|
|
||||
| T1 | [TECH-01-CMS-ARCHITECTURE](../technical/TECH-01-CMS-ARCHITECTURE.md) | معماری CMS | .NET 9، CQRS/MediatR، gRPC، EF Core 9، Hangfire، DB schema |
|
||||
| T2 | [TECH-02-BACKOFFICE-FRONTOFFICE](../technical/TECH-02-BACKOFFICE-FRONTOFFICE.md) | معماری UI | Blazor WASM/Server، MudBlazor v8، Code-behind، RTL، Theme |
|
||||
| T3 | [TECH-03-DEPLOYMENT-INFRA](../technical/TECH-03-DEPLOYMENT-INFRA.md) | استقرار | Docker، K8s، CI/CD، Nexus، Offline deployment، Mirrors |
|
||||
| T4 | [TECH-04-MIGRATION](../technical/TECH-04-MIGRATION.md) | مهاجرت | BFF removal، Gateway removal، Data migration، SQL scripts |
|
||||
| T5 | [TECH-05-API-INTEGRATION](../technical/TECH-05-API-INTEGRATION.md) | API | Proto definitions، ZarinPal/Kavenegar/Daya/Chatika، Error handling |
|
||||
|
||||
### 📊 Overview / Meta
|
||||
|
||||
| # | فایل | موضوع | خلاصه |
|
||||
|---|------|--------|--------|
|
||||
| O1 | [OVERVIEW-01-FLOWCHARTS](OVERVIEW-01-FLOWCHARTS.md) | دیاگرامها | User Journey، Financial Flow، Data Flow، ER Diagram، Network Tree |
|
||||
| O2 | [OVERVIEW-02-INDEX](OVERVIEW-02-INDEX.md) | شاخص | همین فایل — فهرست و نقشه ۱۵ فایل |
|
||||
| O3 | [OVERVIEW-03-CHANGELOG](OVERVIEW-03-CHANGELOG.md) | تاریخچه | همه کارهای انجامشده با بولت + درصد تکمیل |
|
||||
| O4 | [OVERVIEW-04-GLOSSARY](OVERVIEW-04-GLOSSARY.md) | واژهنامه | اصطلاحات فارسی/انگلیسی، استانداردهای کد |
|
||||
| O5 | [OVERVIEW-05-ROADMAP](OVERVIEW-05-ROADMAP.md) | نقشه راه | ریسکها، وابستگیها، کارهای باقیمانده، اولویتها |
|
||||
|
||||
---
|
||||
|
||||
## نقشه ارتباط فایلها
|
||||
|
||||
```
|
||||
┌──────────────┐
|
||||
│ O2: INDEX │ ← شما اینجا هستید
|
||||
└──────┬───────┘
|
||||
│
|
||||
┌─────────────────┼──────────────────┐
|
||||
│ │ │
|
||||
┌────▼────┐ ┌────▼─────┐ ┌────▼─────┐
|
||||
│Business │ │Technical │ │Overview │
|
||||
│ (B1-B5) │ │ (T1-T5) │ │ (O1-O5) │
|
||||
└────┬────┘ └────┬─────┘ └────┬─────┘
|
||||
│ │ │
|
||||
┌────┴────────────────┴──────────────────┴────┐
|
||||
│ │
|
||||
│ B1 ←→ B2 (مالی/باشگاه) │
|
||||
│ B2 ←→ B3 (پرداخت/فروشگاه) │
|
||||
│ B3 ←→ B4 (فروشگاه/کاربر) │
|
||||
│ B4 ←→ B5 (کاربر/محتوا) │
|
||||
│ B1 ←→ T1 (باشگاه/CMS) │
|
||||
│ T1 ←→ T2 (CMS/UI) │
|
||||
│ T1 ←→ T3 (CMS/Deploy) │
|
||||
│ T3 ←→ T4 (Deploy/Migration) │
|
||||
│ T1 ←→ T5 (CMS/API) │
|
||||
│ O1: دیاگرام = بصری B1-B5 + T1-T5 │
|
||||
│ O3: تاریخچه = changelog B1-B5 + T1-T5 │
|
||||
│ O5: آینده = roadmap B1-B5 + T1-T5 │
|
||||
│ │
|
||||
└──────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## نقشه ادغام (53 فایل → 15 فایل)
|
||||
|
||||
<details>
|
||||
<summary>کلیک برای مشاهده mapping کامل</summary>
|
||||
|
||||
| فایل مبدأ | فایل مقصد |
|
||||
|-----------|-----------|
|
||||
| `business/club-commission-system-complete.md` | B1 |
|
||||
| `business/balance-calculation-rules.md` | B1 |
|
||||
| `business/club-membership-contract-system.md` | B1, B4 |
|
||||
| `business/daya-loan-integration.md` | B1, B2 |
|
||||
| `business/discount-shop-business.md` | B2, B3 |
|
||||
| `business/DISCOUNT-STORE-STATUS.md` | B3 |
|
||||
| `business/manual-payment-system.md` | B2 |
|
||||
| `business/package-purchase-system.md` | B1, B2 |
|
||||
| `cms/payment-gateway.md` | B2, T5 |
|
||||
| `cms/payment-architecture-pyms.md` | B2, T1 |
|
||||
| `cms/SITE-PAGES-SIMPLIFICATION.md` | B5 |
|
||||
| `cms/system-constants.md` | B5, T1 |
|
||||
| `cms/email-sms-configuration.md` | B5 |
|
||||
| `cms/chatika-integration.md` | B1, B5, T5 |
|
||||
| `cms/club-feature-management-services.md` | B4, T5 |
|
||||
| `cms/CMS-README.md` | T1 |
|
||||
| `cms/ICURRENTUSERSERVICE-IMPLEMENTATION.md` | B4, T1 |
|
||||
| `cms/FILE-MANAGEMENT-ARCHITECTURE.md` | B5, T1 |
|
||||
| `cms/FRONTOFFICE-CMS-API-COMPATIBILITY.md` | T5 |
|
||||
| `cms/BFF-REMOVAL-PLAN.md` | T1, T4 |
|
||||
| `cms/ADMIN-CUSTOMER-SEPARATION-FIX.md` | B4 |
|
||||
| `cms/REGISTRATION-FLOW-FIXES.md` | B4 |
|
||||
| `cms/INVENTORY-IMPROVEMENTS.md` | B3 |
|
||||
| `cms/INVENTORY-REFACTORING-STATUS.md` | B3 |
|
||||
| `cms/PRODUCT-BUNDLE-FEATURE.md` | B3 |
|
||||
| `cms/REMAINING-TASKS.md` | O5 |
|
||||
| `cms/FRONTOFFICE-RELEASE-NOTES-v1.5.0.md` | O3 |
|
||||
| `deployment/CICD-PIPELINE-GUIDE.md` | T3 |
|
||||
| `deployment/DEPLOYMENT-README.md` | T3 |
|
||||
| `deployment/INFRASTRUCTURE-GUIDE.md` | T3 |
|
||||
| `deployment/INGRESS-NGINX-WARNING.md` | T3 |
|
||||
| `deployment/OFFLINE-DEPLOYMENT-GUIDE.md` | T3 |
|
||||
| `deployment/SERVER-MIRRORS-CONFIG.md` | T3 |
|
||||
| `migration/BACKOFFICE-BFF-MIGRATION.md` | T4 |
|
||||
| `migration/customer-facing-capabilities-codex.md` | T4 |
|
||||
| `migration/DATA-TABLE-MAPPINGS.md` | T4 |
|
||||
| `migration/DATAMIGRATION-README.md` | T4 |
|
||||
| `migration/FRONTOFFICE-TO-CMS-MIGRATION.md` | T4 |
|
||||
| `migration/GATEWAY-REMOVAL-MIGRATION-PLAN.md` | T4 |
|
||||
| `migration/MIGRATION-PROGRESS.md` | T4, O3 |
|
||||
| `ui-modernization/BACKOFFICE-ARCHITECTURE.md` | T2 |
|
||||
| `ui-modernization/BACKOFFICE-STORE-UNIFICATION.md` | T2, B3 |
|
||||
| `ui-modernization/UI-MODERNIZATION-PLAN.md` | T2 |
|
||||
| `ui-modernization/PHASE-1-COMPLETE.md` | T2, O3 |
|
||||
| `ui-modernization/PHASE-3-COMPLETE.md` | T2, O3 |
|
||||
| `ui-modernization/PRODUCT-IMAGES-SQUARE.md` | T2, B3 |
|
||||
| `backoffice/BACKOFFICE-AUDIT.md` | T2, O3 |
|
||||
| `backoffice/BACKOFFICE-CHANGELOG.md` | T2, O3 |
|
||||
| `frontoffice/CHANGELOG.md` | T2, O3 |
|
||||
| `frontoffice/UI-UNIFICATION-PLAN.md` | T2 |
|
||||
| `SHOP-UNIFICATION.md` | B3 |
|
||||
| `INDEX.md` | O2 |
|
||||
| `docs/MOVED-TO-TOTALDOC.md` | — (deleted) |
|
||||
|
||||
</details>
|
||||
Reference in New Issue
Block a user