Thêm dự án mới¶

Các bước tạo tài liệu cho một dự án mới trong repo BA. Quy ước đầy đủ: rules/tai-lieu.md.

1. Tạo thư mục dự án¶

Mỗi dự án là một thư mục trong docs/, đặt tên kebab-case không dấu:

docs/<ten-du-an>/
├── index.md                 ← Tổng quan (copy từ templates/tai-lieu.md)
├── architecture/overview.md
├── business/logic.md
├── server/{database,api,modules}.md
├── security/overview.md
└── deployment/overview.md

Không cần đủ tất cả ngay — tạo file khi có nội dung thật.

2. Khởi đầu từ template¶

Copy templates/tai-lieu.md thành docs/<ten-du-an>/index.md rồi điền tổng quan (stack, mục lục, URL môi trường).

3. Viết nội dung¶

Dùng bộ class hiển thị để bảng dữ liệu đẹp & có tooltip — xem Bộ component & style.

4. Đăng ký để hiển thị (BẮT BUỘC)¶

Cập nhật 3 nơi:

mkdocs.yml → thêm section vào nav:

- <Tên dự án>:
  - <ten-du-an>/index.md
  - Kiến trúc: <ten-du-an>/architecture/overview.md

docs/index.md → thêm một project-card vào mục "Dự án"
docs/llms.txt → thêm dòng index

5. (tùy chọn) Dựng giao diện mẫu¶

Nếu dự án cần mockup: tạo ui-mockups/<ten-du-an>/index.html (bám templates/mockup.html) và thêm một card vào ui-mockups/index.html (trang hub) để bấm xem được. Chi tiết: rules/giao-dien.md.

6. Xem & commit¶

mkdocs serve     # → http://localhost:8000, kiểm tra giao diện tài liệu

Xem mockup nội mạng: cd ui-mockups && python -m http.server 8080 → http://<ip-may-ban>:8080.

Khi ổn, commit theo rules/git-commit.md, push nhánh task rồi mở Merge Request vào main (xem rules/phoi-hop-nhom.md). Quản lý duyệt & merge → CI tự build & deploy.