ifnex/docs/INSTALL-DOCS-UPDATE.fa.md
Kazem Alghasi defdcc22c9 feat(core): complete phase 3.11 and prepare for production deployment
This commit marks the completion of phase 3.11 (UAT Ready) and includes
significant updates to deployment automation, testing, and documentation.

Key changes:
- Implement `ifnex:smoke-test` command for E2E post-deployment validation
- Implement `ifnex:preflight` command for environment audit before migration
- Implement `ifnex:import-fx-rates` for automated multi-source currency
  rate imports (Exir.io and FreeCurrencyAPI)
- Update `CurrencySeeder` to support base currencies (USD, AED, EUR, CNY, IRR)
- Enhance `IfnexSmokeTest` with improved environment-aware checks and
  robust HTTP mocking in tests
- Update project documentation (Roadmap, README, AGENT, Handoff) to reflect
  completed phases 3.7 through 3.11
- Add UAT checklist and installation guides for recent hotfixes
- Update project statistics (models, migrations, endpoints, and test counts)
2026-11-08 06:28:21 +03:30

141 lines
6.0 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 📋 بستهٔ به‌روزرسانی مستندات IFNEX (فاز ۳.۱۱)
تاریخ: ۱۴۰۴/۰۸/۱۱
نسخه: docs-update-3.11
---
## 🎯 هدف
به‌روزرسانی همهٔ فایل‌های مستنداتی پروژه IFNEX تا وضعیت واقعی فاز ۳.۱۱ را
منعکس کنند. مستندات قبلی در فاز ۳.۶/۳.۷ متوقف شده بودند و چند فایل گمراه‌کننده
بودند.
---
## 📦 تغییرات این بسته
### فایل‌های به‌روزرسانی‌شده (۹ فایل)
| # | فایل | تغییر کلیدی |
|---|------|------------|
| ۱ | `README.md` | badge فاز ۳.۶→۳.۱۱، آمار صحیح، banner «فاز ۴/۵ = آینده»، رفرنس به `UAT-3.11.md` و `RATE_IMPORTER.md` |
| ۲ | `AGENT.md` | bump 1.5→1.6، افزودن فازهای 3.8 تا 3.11، دستورات جدید، آمار صحیح، رفع رفرنس `DEPLOYMENT.md`→`RATE_IMPORTER.md` |
| ۳ | `DEPLOYMENT_HANDOFF.md` | bump 1.0→1.1، افزودن §2.9 (smoke-test post-deploy)، آیتم جدید در چک‌لیست نهایی |
| ۴ | `04_Laravel/README.md` | badge فاز ۳.۶→۳.۱۱، آمار (۱۶→۱۹ Resources، ۲۲→۳۱ models، ۴۰→۶۲ migrations)، افزودن ۳ دستور جدید، CurrencySeeder |
| ۵ | `01_Documents/IFNEX_Roadmap.md` | جدول وضعیت با فازهای 3.7 تا 3.11، آمار به‌روز، دامنه‌های تولید صحیح |
| ۶ | `01_Documents/IFNEX_Pro_Backlog.md` | **حذف «دفترچه آدرس» از Pro** (تحویل در فاز 3.9)، به‌روزرسانی تاریخ |
| ۷ | `01_Documents/IFNEX_File_Map.md` | (تغییرات cosmetic — آمار به‌روز) |
| ۸ | `01_Documents/IFNEX_Commercial_Model.md` | (تغییرات cosmetic — یادداشت «Delivered in current version») |
| ۹ | `01_Documents/IFNEX_ADR.md` | (تغییرات cosmetic — یادداشت وضعیت ADR-009) |
### فایل‌های جدید (۱ فایل)
| # | فایل | محتوا |
|---|------|------|
| ۱ | `RATE_IMPORTER.md` | rename از `DEPLOYMENT.md` — محتوا همان است (راهنمای ایمپورت نرخ‌ها) ولی نام درست شد |
### فایل‌های آرشیو‌شده (۳ فایل — انتقال به `01_Documents/archives/`)
این فایل‌ها از ریشهٔ `01_Documents/` به `01_Documents/archives/` منتقل شده‌اند
چون توسط `CLIENT_DELIVERY.md` و `UAT-3.11.md` جایگزین شده‌اند:
| # | فایل | دلیل آرشیو |
|---|------|-----------|
| ۱ | `01_Documents/STATUS.md` | stale از 2026-08-10؛ `CLIENT_DELIVERY.md` جایگزینش کرده |
| ۲ | `01_Documents/IFNEX_Meeting_Summary.md` | one-time summary از 2026-08-29؛ کارهای لیست‌شده همه انجام شد |
| ۳ | `01_Documents/IFNEX_Phase0_Checklist.md` | superseded با Roadmap و CLIENT_DELIVERY |
هر فایل آرشیو‌شده در ابتدای خود بنر «آرشیو شد» دارد.
### فایل‌های حذف‌شده (۱ فایل)
| # | فایل | دلیل حذف |
|---|------|---------|
| ۱ | `DEPLOYMENT.md` (ریشه) | rename شد به `RATE_IMPORTER.md` — محتوا درست ولی نام غلط بود (نباید «استقرار» می‌بود) |
---
## 📥 نحوهٔ نصب
### مرحلهٔ ۱: اکسترکت ZIP
محتوای ZIP را روی ریشهٔ پروژه اکسترکت کنید (Replace):
```
C:\xampp\htdocs\IFNEX-Logistics\
```
ساختار ZIP به‌گونه‌ای طراحی شده که با اکسترکت روی ریشه، فایل‌ها در مسیر
درست قرار بگیرند.
### مرحلهٔ ۲: حذف فایل قدیمی
**دقت مهم:** فایل `DEPLOYMENT.md` در ریشه باید حذف شود چون rename شد.
اگر ویندوز اجازه overwrite به‌جای delete نمی‌دهد:
```powershell
cd C:\xampp\htdocs\IFNEX-Logistics
del DEPLOYMENT.md
```
> اگر فایل `RATE_IMPORTER.md` بعد از اکسترکت موجود است و `DEPLOYMENT.md`
> هم هنوز موجود است، فقط `DEPLOYMENT.md` را حذف کنید.
### مرحلهٔ ۳: بررسی
```powershell
cd C:\xampp\htdocs\IFNEX-Logistics
# باید این فایل‌ها موجود باشند:
dir README.md AGENT.md RATE_IMPORTER.md DEPLOYMENT_HANDOFF.md CLIENT_DELIVERY.md UAT-3.11.md
dir 04_Laravel\README.md
dir 01_Documents\IFNEX_Roadmap.md 01_Documents\IFNEX_Pro_Backlog.md
dir 01_Documents\archives\STATUS.md
# فایل قدیمی نباید موجود باشد:
dir DEPLOYMENT.md # باید بگوید "File Not Found"
```
### مرحلهٔ ۴: تست
چون این فقط تغییر docs است، هیچ تستی لازم نیست. ولی برای اطمینان:
```powershell
cd C:\xampp\htdocs\IFNEX-Logistics\04_Laravel
php artisan test
# انتظار: 82 passed (تغییری نکرده)
```
---
## 🚀 بعد از نصب
```powershell
cd C:\xampp\htdocs\IFNEX-Logistics
git add .
git commit -m "docs: sync all docs to phase 3.11 (README, AGENT, Roadmap, Pro_Backlog, File_Map, ADR, Commercial_Model, 04_Laravel/README, DEPLOYMENT_HANDOFF) — rename DEPLOYMENT.md → RATE_IMPORTER.md, archive 3 stale docs"
git push origin main
```
---
## 📋 خلاصهٔ آمار به‌روز شده
| معیار | مقدار قبلی (در docs) | مقدار واقعی (به‌روز) |
|-------|---------------------|---------------------|
| فاز جاری | ۳.۶ (۸۰٪) | **۳.۱۱ (UAT Ready)** |
| مایگریشن‌ها | ۲۸-۴۰-۵۲ | **۶۲** |
| مدل‌ها | ۱۷-۲۲-۲۶ | **۳۱** |
| Filament Resources | ۱۰+-۱۶-۱۷ | **۱۹** |
| WordPress | 7.0.3 | **7.1** |
| تست‌ها | (ذکر نشده) | **۸۲ تست / ۲۲۰+ assertion** |
| دامنهٔ تست | ifnex.vernahost.ir | **ifnex.ir + system.ifnex.ir** |
---
## 🎯 گام بعدی
پس از push، مستندات پروژه کاملاً همگام با واقعیت کد خواهند بود. کارفرما
می‌تواند `UAT-3.11.md` را برای شروع UAT نهایی مطالعه کند.