|
1 | | -# Flashduty 文档 |
| 1 | +# Flashduty Documentation |
2 | 2 |
|
3 | | -[English](README.en.md) | 中文 |
| 3 | +English | [中文](README_zh.md) |
4 | 4 |
|
5 | | -[Flashduty](https://flashcat.cloud/) 官方文档,基于 [Mintlify](https://mintlify.com/) 构建。 |
| 5 | +[](https://mintlify.com/) |
| 6 | +[](https://docs.flashcat.cloud) |
| 7 | +[](LICENSE) |
6 | 8 |
|
7 | | -## 目录结构 |
| 9 | +Official documentation for [Flashduty](https://flashcat.cloud/), bilingual (Chinese & English), built with [Mintlify](https://mintlify.com/). Covers On-call incident management, RUM real user monitoring, and Monitors alert rules — **390+** pages in total. |
8 | 10 |
|
9 | | -``` |
10 | | -flashduty-docs/ |
11 | | -├── zh/ # 中文文档 |
12 | | -│ ├── on-call/ # On-call 故障管理 |
13 | | -│ ├── rum/ # 真实用户监控 |
14 | | -│ ├── monitors/ # 告警规则配置 |
15 | | -│ ├── platform/ # 平台配置 |
16 | | -│ ├── openapi/ # API 文档 |
17 | | -│ ├── compliance/ # 安全合规 |
18 | | -│ └── changelog/ # 更新日志 |
19 | | -├── en/ # 英文文档(与 zh/ 结构一致) |
20 | | -├── logo/ # Logo 资源 |
21 | | -├── docs.json # Mintlify 配置 |
22 | | -└── .cursor/skills/ # AI Agent Skills |
23 | | -``` |
| 11 | +--- |
| 12 | + |
| 13 | +## Product Modules |
24 | 14 |
|
25 | | -## 产品模块 |
| 15 | +| Module | Description | Docs Path | |
| 16 | +|--------|-------------|-----------| |
| 17 | +| **On-call** | Incident management, alert routing, escalation rules, schedule management | `*/on-call/` | |
| 18 | +| **RUM** | Real User Monitoring, frontend performance and error tracking | `*/rum/` | |
| 19 | +| **Monitors** | Multi-source alert rule configuration | `*/monitors/` | |
| 20 | +| **Platform** | Account management, SSO, permissions, API keys | `*/platform/` | |
| 21 | +| **OpenAPI** | REST API reference | `*/openapi/` | |
26 | 22 |
|
27 | | -| 模块 | 描述 | |
28 | | -|------|------| |
29 | | -| **On-call** | 故障管理、告警路由、分派策略、值班管理 | |
30 | | -| **RUM** | 真实用户监控,前端性能和异常追踪 | |
31 | | -| **Monitors** | 多数据源告警规则配置 | |
| 23 | +--- |
32 | 24 |
|
33 | | -## 本地开发 |
| 25 | +## Quick Start |
34 | 26 |
|
35 | | -### 环境准备 |
| 27 | +### Prerequisites |
36 | 28 |
|
37 | 29 | ```bash |
38 | 30 | npm i -g mint |
39 | 31 | ``` |
40 | 32 |
|
41 | | -### 常用命令 |
| 33 | +### Local Preview |
42 | 34 |
|
43 | 35 | ```bash |
44 | | -# 本地预览 |
45 | 36 | mint dev |
| 37 | +``` |
| 38 | + |
| 39 | +Visit `http://localhost:3000` to view the docs. |
| 40 | + |
| 41 | +### Check Broken Links |
46 | 42 |
|
47 | | -# 检查断链 |
| 43 | +```bash |
48 | 44 | mint broken-links |
49 | 45 | ``` |
50 | 46 |
|
51 | | -## 新增文档 |
| 47 | +> Run this after every content change to catch dead links early. |
| 48 | +
|
| 49 | +--- |
| 50 | + |
| 51 | +## Contributing |
| 52 | + |
| 53 | +We welcome community contributions! Whether it's fixing a typo, improving descriptions, or adding new documentation — every bit helps. |
| 54 | + |
| 55 | +### Adding or Editing Documentation |
52 | 56 |
|
53 | | -### 1. 创建文档 |
| 57 | +1. **Edit Chinese docs** — Create or edit `.mdx` files under `zh/` (Chinese is the source language) |
| 58 | +2. **Update navigation** — Add the page path in `docs.json` for both `zh` and `en` sections |
| 59 | +3. **Translate to English** — Create the corresponding file under `en/`, keeping the path structure consistent |
| 60 | +4. **Validate links** — Run `mint broken-links` to confirm no broken links |
54 | 61 |
|
55 | | -在对应目录创建 `.mdx` 文件: |
| 62 | +### Frontmatter Format |
| 63 | + |
| 64 | +Every `.mdx` file must include: |
56 | 65 |
|
57 | 66 | ```yaml |
58 | 67 | --- |
59 | | -title: "清晰、具体的标题" |
60 | | -description: "简洁说明页面目的" |
| 68 | +title: "Clear, specific title" |
| 69 | +description: "Concise explanation of page purpose" |
61 | 70 | --- |
62 | 71 | ``` |
63 | 72 |
|
64 | | -### 2. 更新导航 |
| 73 | +### Writing Guidelines |
65 | 74 |
|
66 | | -在 `docs.json` 中添加页面路径: |
| 75 | +- Use second person ("you") |
| 76 | +- Use active voice, present tense |
| 77 | +- Use sentence case for English titles (capitalize only first word) |
| 78 | +- Leverage Mintlify components: `<Steps>`, `<Tabs>`, `<Note>`, `<Tip>`, `<Warning>`, `<Frame>`, `<CodeGroup>` |
67 | 79 |
|
68 | | -```json |
69 | | -{ |
70 | | - "group": "快速开始", |
71 | | - "pages": ["zh/on-call/quickstart/quickstart"] |
72 | | -} |
73 | | -``` |
| 80 | +--- |
74 | 81 |
|
75 | | -### 3. 多语言同步 |
| 82 | +## Directory Structure |
76 | 83 |
|
77 | | -- 中英文文档保持结构一致 |
78 | | -- 英文文档放在 `en/` 目录,路径与 `zh/` 对应 |
79 | | -- 使用 `translate-zh-to-en` Skill 进行翻译 |
| 84 | +``` |
| 85 | +flashduty-docs/ |
| 86 | +├── zh/ # Chinese docs (source of truth) |
| 87 | +│ ├── on-call/ # On-call incident management |
| 88 | +│ ├── rum/ # Real User Monitoring |
| 89 | +│ ├── monitors/ # Alert rule configuration |
| 90 | +│ ├── platform/ # Platform settings |
| 91 | +│ ├── openapi/ # API documentation |
| 92 | +│ ├── compliance/ # Security compliance |
| 93 | +│ └── changelog/ # Changelog |
| 94 | +├── en/ # English docs (mirrors zh/) |
| 95 | +├── docs.json # Mintlify configuration & navigation |
| 96 | +└── logo/ # Logo assets |
| 97 | +``` |
80 | 98 |
|
81 | | -## 写作规范 |
| 99 | +--- |
82 | 100 |
|
83 | | -### 语言风格 |
| 101 | +## Translation |
84 | 102 |
|
85 | | -- 使用第二人称("您") |
86 | | -- 使用主动语态 |
87 | | -- 保持简洁直接 |
| 103 | +Chinese is the source language; English is translated from it. When translating: |
88 | 104 |
|
89 | | -### 常用组件 |
| 105 | +- Translate frontmatter `title` and `description` |
| 106 | +- Keep MDX component tags unchanged, translate inner text only |
| 107 | +- Keep code blocks unchanged, translate comments only |
| 108 | +- Update internal link paths from `zh/` to `en/` |
| 109 | +- Keep image paths unchanged |
90 | 110 |
|
91 | | -| 组件 | 用途 | |
92 | | -|------|------| |
93 | | -| `<Steps>` | 流程步骤 | |
94 | | -| `<Tabs>` | 平台差异 | |
95 | | -| `<CodeGroup>` | 多语言代码 | |
96 | | -| `<Note>` / `<Tip>` / `<Warning>` | 提示信息 | |
97 | | -| `<Frame>` | 图片容器 | |
| 111 | +### Key Terminology |
98 | 112 |
|
99 | | -### 代码示例 |
| 113 | +| Chinese | English | |
| 114 | +|---------|---------| |
| 115 | +| 协作空间 | channel | |
| 116 | +| 故障 | incident | |
| 117 | +| 分派策略 | escalation rule | |
| 118 | +| 值班表 | schedule | |
| 119 | +| 认领 | acknowledge | |
| 120 | +| 静默策略 | silence rule | |
| 121 | +| 抑制策略 | inhibit rule | |
| 122 | +| 排除规则 | drop rule | |
100 | 123 |
|
101 | | -- 提供完整、可运行的示例 |
102 | | -- 指定语言和文件名 |
103 | | -- 不包含真实 API 密钥 |
| 124 | +Full glossary: `.cursor/skills/translate-zh-to-en/glossary.md` |
104 | 125 |
|
105 | | -## AI 辅助 |
| 126 | +--- |
106 | 127 |
|
107 | | -本项目提供两个 AI Skills: |
| 128 | +## Related Resources |
108 | 129 |
|
109 | | -| Skill | 用途 | |
110 | | -|-------|------| |
111 | | -| `translate-zh-to-en` | 将中文文档翻译为英文 | |
112 | | -| `polish-document` | 按规范润色优化文档 | |
| 130 | +| Resource | Link | |
| 131 | +|----------|------| |
| 132 | +| Flashduty Docs | [docs.flashcat.cloud](https://docs.flashcat.cloud) | |
| 133 | +| Flashduty Console | [console.flashcat.cloud](https://console.flashcat.cloud/) | |
| 134 | +| Flashduty Website | [flashcat.cloud](https://flashcat.cloud/) | |
| 135 | +| MCP Server | [flashduty-mcp-server](https://github.com/flashcatcloud/flashduty-mcp-server) | |
| 136 | +| Terraform Provider | [terraform-provider-flashduty](https://github.com/flashcatcloud/terraform-provider-flashduty) | |
| 137 | +| Mintlify Docs | [mintlify.com/docs](https://mintlify.com/docs) | |
113 | 138 |
|
114 | | -详见 [AGENTS.md](AGENTS.md) |
| 139 | +--- |
115 | 140 |
|
116 | | -## 相关链接 |
| 141 | +## License |
117 | 142 |
|
118 | | -- [Flashduty 控制台](https://console.flashcat.cloud/) |
119 | | -- [Flashduty 官网](https://flashcat.cloud/) |
120 | | -- [Mintlify 文档](https://mintlify.com/docs) |
| 143 | +This project is licensed under the MIT License — see the [LICENSE](LICENSE) file for details. |
0 commit comments