docs: Cập nhật ví dụ biểu đồ Mermaid với bảng màu mới và chuẩn hóa các tiêu đề mục tiếng Việt.

This commit is contained in:
Ho Ngoc Hai
2026-01-07 22:47:19 +07:00
parent 03c76fecb5
commit 5925b9c067
5 changed files with 37 additions and 31 deletions

View File

@@ -234,9 +234,9 @@ graph LR
Long --> Config[Static Config]
Long --> RefData[Reference Data]
style Short fill:#f8d7da
style Medium fill:#fff3cd
style Long fill:#d4edda
%% style Short fill:#f8d7da
%% style Medium fill:#fff3cd
%% style Long fill:#d4edda
```
**Hướng dẫn TTL / TTL Guidelines**:

View File

@@ -117,12 +117,14 @@ Tham khảo [Hướng dẫn Mermaid](./mermaid-guide.md) để biết:
**Color Palette**:
```
#e1f5ff - Xanh nhạt (Primary actions)
#fff4e1 - Vàng nhạt (Data/Cache)
#f0e1ff - Tím nhạt (Processing)
#d4edda - Xanh lá nhạt (Success)
#f8d7da - Đỏ nhạt (Errors)
#fff3cd - Vàng (Warnings)
#4A90E2 - Xanh dương (Primary actions)
#F5A623 - Cam vàng (Data/Cache)
#9013FE - Tím (Processing)
#50E3C2 - Xanh lá (Success)
#E74C3C - Đỏ (Errors)
#F39C12 - Vàng cam (Warnings)
#7B68EE - Tím xanh (Info)
#95A5A6 - Xám (Neutral)
```
### File Organization
@@ -135,27 +137,27 @@ docs/vi/
└── skills/ # Patterns & skills
```
## Best Practices
## Thực hành Tốt nhất
### 1. Viết Concise và Clear
### 1. Viết Ngắn gọn và Rõ ràng
- Ngắn gọn, súc tích
- Một ý chính mỗi paragraph
- Sử dụng bullet points cho lists
### 2. Visual First
### 2. Ưu tiên Hình ảnh
- Thêm diagrams cho mọi concepts phức tạp
- Sử dụng code examples với output
- Screenshots khi cần (UI, browser)
### 3. Maintainability
### 3. Khả năng Bảo trì
- Link tới related documentation
- Cập nhật "Last Updated" date
- Ghi rõ version nếu có
### 4. Accessibility
### 4. Khả năng Truy cập
- Alt text cho images
- Descriptive link text (không dùng "click here")
@@ -190,7 +192,7 @@ markdownlint docs/vi/**/*.md
[Code Example](file:///path/to/file.ts#L10-L20)
```
## Troubleshooting
## Khắc phục Sự cố
### Mermaid không hiển thị?

View File

@@ -224,4 +224,4 @@ graph LR
---
**Authors / Tác giả**: VelikHo (hongochai10@icloud.com)
**Reviewers / Người review**: Reviewer Names
**Reviewers / Người đánh giá**: Reviewer Names

View File

@@ -423,18 +423,22 @@ C4Context
```mermaid
graph LR
A["Primary<br/>#e1f5ff"] --> B["Secondary<br/>#fff4e1"]
B --> C["Success<br/>#d4edda"]
C --> D["Warning<br/>#fff3cd"]
D --> E["Error<br/>#f8d7da"]
E --> F["Info<br/>#f0e1ff"]
A["Primary<br/>#4A90E2"] --> B["Data/Cache<br/>#F5A623"]
B --> C["Success<br/>#50E3C2"]
C --> D["Warning<br/>#F39C12"]
D --> E["Error<br/>#E74C3C"]
E --> F["Processing<br/>#9013FE"]
F --> G["Info<br/>#7B68EE"]
G --> H["Neutral<br/>#95A5A6"]
style A fill:#e1f5ff
style B fill:#fff4e1
style C fill:#d4edda
style D fill:#fff3cd
style E fill:#f8d7da
style F fill:#f0e1ff
style A fill:#4A90E2
style B fill:#F5A623
style C fill:#50E3C2
style D fill:#F39C12
style E fill:#E74C3C
style F fill:#9013FE
style G fill:#7B68EE
style H fill:#95A5A6
```
### Style Syntax
@@ -452,7 +456,7 @@ style Process fill:#d4edda,stroke:#28a745,stroke-width:2px
---
## Best Practices / Best Practices
## Best Practices / Thực hành Tốt nhất
### EN: Guidelines
@@ -472,7 +476,7 @@ style Process fill:#d4edda,stroke:#28a745,stroke-width:2px
---
## Common Pitfalls / Lỗi Thường gặp
## Cạm bẫy Thường gặp
### ❌ Too Complex
@@ -509,7 +513,7 @@ graph TD
---
## Testing Diagrams / Test Sơ đồ
## Kiểm tra Sơ đồ
**EN**: Always test your diagrams before committing:

View File

@@ -309,7 +309,7 @@ const result1 = await pattern.execute(input);
const result2 = await pattern.execute(input); // Returns cached result
```
## Best Practices / Best Practices
## Best Practices / Thực hành Tốt nhất
### EN: Recommended Practices