Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,15 @@ Prerequisite: `npm i -g mint`

- **`docs.json`** — Central Mintlify config: navigation structure, tabs, theme. All new pages must be registered here under the correct language → tab → group.
- **`zh/`** and **`en/`** — Mirror each other. Chinese is the source of truth; English is translated from it.
- **`.cursor/skills/`** — AI agent skills for translation (`translate-zh-to-en`) and polishing (`polish-document`), with glossary and standards resources.
- **`glossary.md`** — Chinese-English terminology glossary for translation consistency.
- **`api-reference/`** — OpenAPI 3.1 spec files (per-module, per-language) powering the API Reference tab.
- **`.cursor/skills/`** — AI agent skills for translation (`translate-zh-to-en`) and polishing (`polish-document`).

## Documentation Workflow

1. Create/edit Chinese docs in `zh/` as `.mdx` files
2. Add the page path to `docs.json` navigation (both `zh` and `en` language sections)
3. Translate to English using the glossary at `.cursor/skills/translate-zh-to-en/glossary.md`
3. Translate to English using the glossary at `glossary.md`
4. Run `mint broken-links` to validate

## Key Terminology (zh → en)
Expand All @@ -57,7 +59,7 @@ These are non-obvious translations that must stay consistent:
| 规则告警聚合 | pattern alert grouping |
| 智能告警聚合 | intelligent alert grouping |

Full glossary: `.cursor/skills/translate-zh-to-en/glossary.md`
Full glossary: `glossary.md`

## Writing Conventions

Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ flashduty-docs/
│ ├── compliance/ # Security compliance
│ └── changelog/ # Changelog
├── en/ # English docs (mirrors zh/)
├── api-reference/ # OpenAPI 3.1 specs (per-module, per-language)
├── glossary.md # Chinese-English terminology glossary
├── docs.json # Mintlify configuration & navigation
└── logo/ # Logo assets
```
Expand Down Expand Up @@ -121,7 +123,7 @@ Chinese is the source language; English is translated from it. When translating:
| 抑制策略 | inhibit rule |
| 排除规则 | drop rule |

Full glossary: `.cursor/skills/translate-zh-to-en/glossary.md`
Full glossary: [`glossary.md`](glossary.md)

---

Expand Down
4 changes: 3 additions & 1 deletion README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ flashduty-docs/
│ ├── compliance/ # 安全合规
│ └── changelog/ # 更新日志
├── en/ # 英文文档(与 zh/ 结构一致)
├── api-reference/ # OpenAPI 3.1 规范文件(按模块和语言拆分)
├── glossary.md # 中英术语对照表
├── docs.json # Mintlify 配置与导航
└── logo/ # Logo 资源
```
Expand Down Expand Up @@ -121,7 +123,7 @@ flashduty-docs/
| 抑制策略 | inhibit rule |
| 排除规则 | drop rule |

完整术语表见 `.cursor/skills/translate-zh-to-en/glossary.md`。
完整术语表见 [`glossary.md`](glossary.md)

---

Expand Down
Loading