Skip to content

Commit 9443d97

Browse files
ysyneuclaude
andcommitted
docs: rewrite READMEs with badges, contributing guide, and English as default
Make English README the default (README.md) and move Chinese to README_zh.md. Add shields.io badges, product module table with paths, contributing section, translation guide with key terminology, and related resources linking to MCP server and Terraform provider repos. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 592a4dd commit 9443d97

3 files changed

Lines changed: 241 additions & 195 deletions

File tree

README.en.md

Lines changed: 0 additions & 120 deletions
This file was deleted.

README.md

Lines changed: 98 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,120 +1,143 @@
1-
# Flashduty 文档
1+
# Flashduty Documentation
22

3-
[English](README.en.md) | 中文
3+
English | [中文](README_zh.md)
44

5-
[Flashduty](https://flashcat.cloud/) 官方文档,基于 [Mintlify](https://mintlify.com/) 构建。
5+
[![Mintlify](https://img.shields.io/badge/Built_with-Mintlify-8B5CF6?style=flat-square)](https://mintlify.com/)
6+
[![Docs](https://img.shields.io/badge/Live-docs.flashcat.cloud-blue?style=flat-square)](https://docs.flashcat.cloud)
7+
[![License: MIT](https://img.shields.io/badge/License-MIT-green?style=flat-square)](LICENSE)
68

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

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
2414

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/` |
2622

27-
| 模块 | 描述 |
28-
|------|------|
29-
| **On-call** | 故障管理、告警路由、分派策略、值班管理 |
30-
| **RUM** | 真实用户监控,前端性能和异常追踪 |
31-
| **Monitors** | 多数据源告警规则配置 |
23+
---
3224

33-
## 本地开发
25+
## Quick Start
3426

35-
### 环境准备
27+
### Prerequisites
3628

3729
```bash
3830
npm i -g mint
3931
```
4032

41-
### 常用命令
33+
### Local Preview
4234

4335
```bash
44-
# 本地预览
4536
mint dev
37+
```
38+
39+
Visit `http://localhost:3000` to view the docs.
40+
41+
### Check Broken Links
4642

47-
# 检查断链
43+
```bash
4844
mint broken-links
4945
```
5046

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
5256

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
5461

55-
在对应目录创建 `.mdx` 文件:
62+
### Frontmatter Format
63+
64+
Every `.mdx` file must include:
5665

5766
```yaml
5867
---
59-
title: "清晰、具体的标题"
60-
description: "简洁说明页面目的"
68+
title: "Clear, specific title"
69+
description: "Concise explanation of page purpose"
6170
---
6271
```
6372

64-
### 2. 更新导航
73+
### Writing Guidelines
6574

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>`
6779

68-
```json
69-
{
70-
"group": "快速开始",
71-
"pages": ["zh/on-call/quickstart/quickstart"]
72-
}
73-
```
80+
---
7481

75-
### 3. 多语言同步
82+
## Directory Structure
7683

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+
```
8098

81-
## 写作规范
99+
---
82100

83-
### 语言风格
101+
## Translation
84102

85-
- 使用第二人称("您")
86-
- 使用主动语态
87-
- 保持简洁直接
103+
Chinese is the source language; English is translated from it. When translating:
88104

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
90110

91-
| 组件 | 用途 |
92-
|------|------|
93-
| `<Steps>` | 流程步骤 |
94-
| `<Tabs>` | 平台差异 |
95-
| `<CodeGroup>` | 多语言代码 |
96-
| `<Note>` / `<Tip>` / `<Warning>` | 提示信息 |
97-
| `<Frame>` | 图片容器 |
111+
### Key Terminology
98112

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 |
100123

101-
- 提供完整、可运行的示例
102-
- 指定语言和文件名
103-
- 不包含真实 API 密钥
124+
Full glossary: `.cursor/skills/translate-zh-to-en/glossary.md`
104125

105-
## AI 辅助
126+
---
106127

107-
本项目提供两个 AI Skills:
128+
## Related Resources
108129

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) |
113138

114-
详见 [AGENTS.md](AGENTS.md)
139+
---
115140

116-
## 相关链接
141+
## License
117142

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

Comments
 (0)