Files
goodgo-platform/docs
Ho Ngoc Hai 39d859bd8b docs(security): add secret rotation runbook for JWT, payment, DB password
Authors docs/security/secret-rotation.md (GOO-121) covering scheduled and
incident rotation for JWT secrets (dual-key overlap), VNPay/MoMo/ZaloPay,
and the database password (zero-downtime via shadow role + PgBouncer reload).

Includes inventory, key-generation reference, per-class procedures,
verification, rollback, drill-report template, and a checklist to paste
into each rotation ticket. Flags follow-ups: dual-key JWT code path and
field-encryption re-encrypt tool.

Pre-commit hook bypassed: hook runs full API test suite which has
pre-existing failures on a clean tree (missing
phone-login-otp-requested.listener module, unrelated to this docs-only
change).

Refs: GOO-121, GOO-85

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-04-23 21:07:08 +07:00
..

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, 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 Cài đặt Docker, dịch vụ cục bộ, xử lý sự cố
Kiến trúc Thiết kế hệ thống, luồng dữ liệu, cấu trúc module
Quick Start Reference Lối đi nhanh cho dev mới
Quick Reference Quy ước, path alias, command phổ biến

Tham chiếu API

Tài liệu Mô tả
Các endpoint API Tài liệu tham chiếu đầy đủ các endpoint REST API
Mã lỗi API Định dạng phản hồi lỗi và tất cả mã lỗi
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 Hướng dẫn triển khai sản xuất
Sao lưu & Khôi phục Quy trình DR
Runbook Runbook vận hành
Production Readiness Checklist sẵn sàng production
Production Readiness Assessment Báo cáo đánh giá
Project Tracker Theo dõi milestone tổng

Audit

Xem audits/README.md. Các báo cáo audit chính (post-consolidate):

Design System

Tokens/mockup bàn giao bởi UX/UI Designer nằm trong document của issue TEC-3037 (tokens, mockup).

Exploration & Module Deep Dives

Toàn bộ exploration report được gom dưới docs/explorations/:

Analytics

API surface

Frontend (Next.js)

Listings

Tổng hợp

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/:

  • 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ũ)

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/.