admin/goodgo-platform
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
abeb8fd3227f351ab6f23c9e0dfe8d0b5518da88
goodgo-platform/docs/README.md
Ho Ngoc Hai 08b96f9c2d docs: consolidate exploration & audit reports under docs/ (TEC-3094) 
- Move 8 stray .md (+5 .txt) from ~/Desktop into docs/explorations/from-desktop/
- Reorganize 27 .md/.txt at workspace root:
  - audit reports -> docs/audits/
  - exploration reports -> docs/explorations/
  - design system -> docs/design-system/
- Keep only README/CHANGELOG/CONTRIBUTING/CLAUDE at repo root
- Refresh docs/README.md as canonical index with links to all groups
- Note: pre-existing docs/audits/AUDIT_INDEX.md and AUDIT_SUMMARY.md were
  overwritten by the newer root-level versions during the move

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-04-21 16:29:24 +07:00

99 lines
5.1 KiB
Markdown
Raw Blame History

# Tài liệu GoodGo Platform
Mục lục tổng hợp cho toàn bộ tài liệu dưới `docs/`. Sau đợt consolidate ở [TEC-3094](/TEC/issues/TEC-3094), mọi exploration / audit / design-system đã được gom vào đây, **không còn file .md dự án ở repo root ngoài 4 file chuẩn** (`README.md`, `CHANGELOG.md`, `CONTRIBUTING.md`, `CLAUDE.md`) hoặc ngoài workspace (`~/Desktop`).
## Bắt đầu
| Tài liệu | Mô tả |
|----------|-------|
| [Môi trường phát triển](dev-environment.md) | Cài đặt Docker, dịch vụ cục bộ, xử lý sự cố |
| [Kiến trúc](architecture.md) | Thiết kế hệ thống, luồng dữ liệu, cấu trúc module |
| [Quick Start Reference](QUICK_START_REFERENCE.md) | Lối đi nhanh cho dev mới |
| [Quick Reference](QUICK_REFERENCE.md) | Quy ước, path alias, command phổ biến |
## Tham chiếu API
| Tài liệu | Mô tả |
|----------|-------|
| [Các endpoint API](api-endpoints.md) | Tài liệu tham chiếu đầy đủ các endpoint REST API |
| [Mã lỗi API](api-error-codes.md) | Định dạng phản hồi lỗi và tất cả mã lỗi |
| [api/market-index-ticker-contract.md](api/market-index-ticker-contract.md) | Contract sàn giao dịch (TEC-3043) |
## Vận hành
| Tài liệu | Mô tả |
|----------|-------|
| [Triển khai](deployment.md) | Hướng dẫn triển khai sản xuất |
| [Sao lưu & Khôi phục](backup-restore.md) | Quy trình DR |
| [Runbook](RUNBOOK.md) | Runbook vận hành |
| [Production Readiness](PRODUCTION_READINESS.md) | Checklist sẵn sàng production |
| [Production Readiness Assessment](PRODUCTION_READINESS_ASSESSMENT.md) | Báo cáo đánh giá |
| [Project Tracker](PROJECT_TRACKER.md) | Theo dõi milestone tổng |
## Audit
Xem [audits/README.md](audits/README.md). Các báo cáo audit chính (post-consolidate):
- [AUDIT_INDEX](audits/AUDIT_INDEX.md), [AUDIT_SUMMARY](audits/AUDIT_SUMMARY.md), [README_AUDIT_FILES](audits/README_AUDIT_FILES.md)
- [AUDIT_REPORT_2026_04_21](audits/AUDIT_REPORT_2026_04_21.md)
- [AUDIT_LISTINGS_PROPERTY_MANAGEMENT](audits/AUDIT_LISTINGS_PROPERTY_MANAGEMENT.md)
- [BACKEND_API_AUDIT_EXCHANGE_UI](audits/BACKEND_API_AUDIT_EXCHANGE_UI.md) + [quick reference](audits/BACKEND_API_AUDIT_QUICK_REFERENCE.txt)
## Design System
- [DESIGN_SYSTEM_AUDIT_2026_04_21](design-system/DESIGN_SYSTEM_AUDIT_2026_04_21.md)
- [DESIGN_SYSTEM_QUICK_REFERENCE](design-system/DESIGN_SYSTEM_QUICK_REFERENCE.md)
Tokens/mockup bàn giao bởi UX/UI Designer nằm trong document của issue [TEC-3037](/TEC/issues/TEC-3037) (`tokens`, `mockup`).
## Exploration & Module Deep Dives
Toàn bộ exploration report được gom dưới `docs/explorations/`:
### Analytics
- [ANALYTICS_ARCHITECTURE](explorations/ANALYTICS_ARCHITECTURE.md) + [diagram](explorations/ANALYTICS_ARCHITECTURE_DIAGRAM.txt)
- [ANALYTICS_QUICK_REFERENCE](explorations/ANALYTICS_QUICK_REFERENCE.md)
- [README_ANALYTICS_DOCS](explorations/README_ANALYTICS_DOCS.md)
### API surface
- [API_DOCUMENTATION_INDEX](explorations/API_DOCUMENTATION_INDEX.md)
- [API_ENDPOINTS_REFERENCE](explorations/API_ENDPOINTS_REFERENCE.md)
- [API_EXPLORATION_SUMMARY](explorations/API_EXPLORATION_SUMMARY.md)
### Frontend (Next.js)
- [FRONTEND_DOCUMENTATION_INDEX](explorations/FRONTEND_DOCUMENTATION_INDEX.md)
- [NEXTJS_FRONTEND_STRUCTURE](explorations/NEXTJS_FRONTEND_STRUCTURE.md)
- [NEXTJS_QUICK_REFERENCE](explorations/NEXTJS_QUICK_REFERENCE.md)
- [NEXTJS_VISUAL_FLOWCHART](explorations/NEXTJS_VISUAL_FLOWCHART.md)
- [UI_MAPPING_QUICK_GUIDE](explorations/UI_MAPPING_QUICK_GUIDE.md)
### Listings
- [LISTINGS_MODULE_EXPLORATION](explorations/LISTINGS_MODULE_EXPLORATION.md)
- [LISTINGS_DATA_SCHEMA](explorations/LISTINGS_DATA_SCHEMA.md)
- [LISTINGS_QUICK_REFERENCE](explorations/LISTINGS_QUICK_REFERENCE.md)
- [EXPLORATION_SUMMARY_LISTINGS](explorations/EXPLORATION_SUMMARY_LISTINGS.md)
- [README_LISTINGS_EXPLORATION](explorations/README_LISTINGS_EXPLORATION.md)
### Tổng hợp
- [EXPLORATION_SUMMARY](explorations/EXPLORATION_SUMMARY.md)
### Recovered from `~/Desktop`
Trước đây các sub-agent exploration đã ghi nhầm ra `~/Desktop`. Tất cả đã được gom về [`explorations/from-desktop/`](explorations/from-desktop/):
- `00_SUMMARY.md`, `01_analytics_architecture_guide.md`, `02_quick_reference.md`, `03_file_paths_reference.md`
- `FRONTEND_EXPLORATION_REPORT.md`, `INDEX_frontend_exploration.md`, `NOTIFICATIONS_EXPLORATION.md`
- `README_analytics_package.md` (vốn là Desktop/README.md)
- `ARCHITECTURE_OVERVIEW.txt`, `FRONTEND_QUICK_REFERENCE.txt`, `README_EXPLORATION.txt`
## Frontend docs (bản cũ)
- [README_FRONTEND_DOCS](README_FRONTEND_DOCS.md)
- [README_NEW_DOCUMENTATION](README_NEW_DOCUMENTATION.md)
## Quy ước
- **Không** tạo file `.md` dự án ở repo root (ngoài `README.md`, `CHANGELOG.md`, `CONTRIBUTING.md`, `CLAUDE.md`).
- **Không** ghi file dự án ra ngoài workspace (ví dụ `~/Desktop`). Mọi output của exploration/audit phải relative trong `docs/…`.
- Đặt file audit theo mẫu `AUDIT_<topic>_<YYYY_MM_DD>.md` trong `docs/audits/`.
- Đặt exploration theo `<MODULE>_<TOPIC>.md` trong `docs/explorations/`.
Reference in New Issue View Git Blame Copy Permalink