update docs

Author: pijiang3

README.md

@@ -1,66 +1,171 @@
-# Flashduty Documentation
+# Flashduty 文档
 
-This repository contains the official documentation for [Flashduty](https://flashcat.cloud/), an incident management and on-call platform similar to PagerDuty. Built with [Mintlify](https://mintlify.com/).
+本仓库是 [Flashduty](https://flashcat.cloud/) 的官方文档，基于 [Mintlify](https://mintlify.com/) 构建。
 
-## Documentation Structure
+## 目录结构
 
 ```
 docs/
-├── zh/                    # Chinese documentation
-│   ├── home.mdx           # Homepage
-│   ├── on-call/           # On-call product docs
-│   ├── rum/               # RUM product docs
-│   ├── monitors/          # Monitors product docs
-│   ├── platform/          # Platform configuration
-│   ├── openapi/           # API documentation
-│   └── ...
-├── en/                    # English documentation
-│   └── (same structure as zh/)
-├── logo/                  # Logo assets
-└── docs.json              # Mintlify configuration
+├── zh/                    # 中文文档
+│   ├── home.mdx           # 首页
+│   ├── on-call/           # On-call 产品文档
+│   ├── rum/               # RUM 产品文档
+│   ├── monitors/          # Monitors 产品文档
+│   ├── platform/          # 平台配置
+│   ├── openapi/           # API 文档
+│   ├── compliance/        # 安全合规
+│   └── changelog/         # 更新日志
+├── en/                    # 英文文档（与 zh/ 结构一致）
+├── logo/                  # Logo 资源
+├── docs.json              # Mintlify 配置文件
+└── .cursor/rules/         # 写作规范
+    ├── rule.md            # Mintlify 技术写作规范
+    └── term.md            # 翻译术语表
 ```
 
-## Products
+## 产品模块
 
-- **On-call**: Incident management, alert routing, escalation rules, and on-call scheduling
-- **RUM**: Real User Monitoring for frontend performance and error tracking
-- **Monitors**: Alert rules configuration for various data sources
+- **On-call**：故障管理、告警路由、分派策略、值班管理
+- **RUM**：真实用户监控，前端性能和异常追踪
+- **Monitors**：多数据源告警规则配置
 
-## Development
+## 本地开发
 
-### Prerequisites
+### 环境准备
 
-Install the [Mintlify CLI](https://www.npmjs.com/package/mint):
+安装 [Mintlify CLI](https://www.npmjs.com/package/mint)：
 
 ```bash
 npm i -g mint
 ```
 
-### Local Preview
+### 本地预览
 
-Run the following command at the root of this repository:
+在仓库根目录运行：
 
 ```bash
 mint dev
 ```
 
-View your local preview at `http://localhost:3000`.
+访问 `http://localhost:3000` 查看本地预览。
 
-### Check for Errors
+### 检查错误
 
 ```bash
 mint broken-links
 ```
 
-## Contributing
+## 新增文档
 
-1. All documentation supports both Chinese (`zh/`) and English (`en/`) languages
-2. Follow the existing file structure and naming conventions
-3. Use Mintlify components for consistent styling
-4. Test changes locally before submitting
+### 1. 创建文档文件
 
-## Resources
+在对应目录下创建 `.mdx` 文件，文件必须以 YAML frontmatter 开头：
 
-- [Flashduty Console](https://console.flashcat.cloud/)
-- [Flashduty Website](https://flashcat.cloud/)
-- [Mintlify Documentation](https://mintlify.com/docs)
+```yaml
+---
+title: "清晰、具体的标题"
+description: "简洁说明页面目的和价值"
+keywords: ["关键词1", "关键词2", "关键词3"]
+---
+```
+
+### 2. 更新导航配置
+
+在 `docs.json` 中添加新页面路径。找到对应的 `tab` 和 `group`，将文件路径添加到 `pages` 数组中：
+
+```json
+{
+  "group": "快速开始",
+  "pages": [
+    "zh/on-call/quickstart/quickstart",
+    "zh/on-call/quickstart/your-new-page"  // 新增页面
+  ]
+}
+```
+
+### 3. 使用规范优化文档
+
+根据 `.cursor/rules/rule.md` 规范，使用 AI 进行文档优化，主要包括：
+
+#### 页面结构规范
+
+- 以最重要的信息开头（倒金字塔结构）
+- 使用渐进式披露：基本概念在高级概念之前
+- 将复杂程序分解为编号步骤
+- 使用描述性、关键词丰富的标题
+
+#### 常用组件
+
+| 组件 | 用途 |
+|------|------|
+| `<Steps>` | 流程和顺序说明 |
+| `<Tabs>` | 平台特定内容或替代方法 |
+| `<CodeGroup>` | 多语言代码示例 |
+| `<Accordion>` | 可折叠的补充信息 |
+| `<Note>` / `<Tip>` / `<Warning>` | 标注提示信息 |
+| `<Frame>` | 图片容器 |
+| `<CardGroup>` | 相关链接卡片组 |
+
+#### 示例：分步说明
+
+````mdx
+<Steps>
+<Step title="安装依赖">
+  运行安装命令：
+  ```bash
+  npm install
+  ```
+</Step>
+
+<Step title="配置环境">
+  创建配置文件并填写参数。
+</Step>
+</Steps>
+````
+
+#### 示例：多语言代码
+
+````mdx
+<Tabs>
+<Tab title="Swift">
+```swift
+let config = Config()
+```
+</Tab>
+
+<Tab title="Objective-C">
+```objc
+Config *config = [[Config alloc] init];
+```
+</Tab>
+</Tabs>
+````
+
+### 4. 多语言同步
+
+- 中英文文档需保持结构一致
+- 翻译时参考 `.cursor/rules/term.md` 术语表
+- 英文文档放在 `en/` 目录，路径与 `zh/` 对应
+
+## 写作规范速查
+
+### 语言风格
+
+- 使用清晰、直接的语言
+- 在说明中使用第二人称（"您"）
+- 使用主动语态
+- 避免术语，必要时首次使用时定义
+
+### 代码示例要求
+
+- 提供完整、可运行的示例
+- 指定语言并包含文件名
+- 为复杂逻辑添加注释
+- 永远不要包含真实的 API 密钥
+
+
+## 相关资源
+
+- [Flashduty 控制台](https://console.flashcat.cloud/)
+- [Flashduty 官网](https://flashcat.cloud/)
+- [Mintlify 文档](https://mintlify.com/docs)

en/rum/error-tracking/erro-reporting/android.mdx

@@ -1,17 +1,17 @@
 ---
 title: "Android Error Reporting"
-description: "Master Flashduty RUM Android SDK error capture mechanisms, including Java/Kotlin crashes, NDK crashes, ANR reporting, manual reporting, and symbolication configuration"
+description: "Master Android RUM SDK error capture mechanisms, including Java/Kotlin crashes, NDK crashes, ANR reporting, manual reporting, and symbolication configuration"
 ---
 
-This document covers the error capture mechanisms of the Flashcat Android RUM SDK, helping you monitor and diagnose crashes and errors in Android applications.
+This document covers the error capture mechanisms of the Android RUM SDK, helping you monitor and diagnose crashes and errors in Android applications.
 
 <Info>
 The SDK supports automatic capture of Java/Kotlin crashes, NDK native crashes, and ANR (Application Not Responding), while also providing manual error reporting and symbolicated stack trace features.
 </Info>
 
 ## Error Types
 
-Flashcat Android RUM can monitor the following types of errors:
+Android RUM can monitor the following types of errors:
 
 ### Java/Kotlin Crashes
 

en/rum/error-tracking/erro-reporting/ios.mdx

@@ -1,17 +1,17 @@
 ---
 title: "iOS"
-description: "Master Flashduty RUM iOS SDK error capture mechanisms, including crash capture, App Hangs, Watchdog terminations, manual reporting, and dSYM symbolication"
+description: "Master iOS RUM SDK error capture mechanisms, including crash capture, App Hangs, Watchdog terminations, manual reporting, and dSYM symbolication"
 ---
 
-This document covers the error capture mechanisms of the Flashcat iOS RUM SDK, helping you monitor and diagnose crashes and errors in iOS applications.
+This document covers the error capture mechanisms of the iOS RUM SDK, helping you monitor and diagnose crashes and errors in iOS applications.
 
 <Info>
 The SDK supports automatic capture of application crashes, App Hangs (application freezes), and Watchdog terminations, while also providing manual error reporting and dSYM symbolication features.
 </Info>
 
 ## Error Types
 
-Flashcat iOS RUM can monitor the following types of errors:
+iOS RUM can monitor the following types of errors:
 
 ### Application Crashes
 

en/rum/error-tracking/erro-reporting/web.mdx

@@ -1,13 +1,13 @@
 ---
 title: "Web"
-description: "Learn about Flashduty RUM error reporting mechanisms for web applications"
+description: "Learn about RUM error reporting mechanisms for web applications"
 ---
 
 This document covers error types, capture mechanisms, manual reporting methods, React integration, and the error data structure definition.
 
 ## Error Types
 
-Flashduty RUM can monitor the following types of errors:
+RUM can monitor the following types of errors:
 
 <Tabs>
   <Tab title="JavaScript Errors">
@@ -38,7 +38,7 @@ Flashduty RUM can monitor the following types of errors:
 
 ### Automatic Error Capture
 
-Flashduty RUM SDK automatically captures the following types of browser errors:
+RUM SDK automatically captures the following types of browser errors:
 
 | Error Type | Description |
 |------------|-------------|
@@ -96,7 +96,7 @@ try {
 
 ### React Error Boundary Integration
 
-Flashduty RUM supports capturing component rendering errors through React [Error Boundaries](https://legacy.reactjs.org/docs/error-boundaries.html) and reporting error information. You can call the `addError` API in `componentDidCatch` to attach component stack information for debugging.
+RUM supports capturing component rendering errors through React [Error Boundaries](https://legacy.reactjs.org/docs/error-boundaries.html) and reporting error information. You can call the `addError` API in `componentDidCatch` to attach component stack information for debugging.
 
 <Steps>
   <Step title="Create Error Boundary Component">
@@ -159,7 +159,7 @@ Each error record contains the following attributes describing error details and
 
 ## Error Filtering and Configuration
 
-To ensure error data accuracy and relevance, Flashduty RUM applies the following filtering rules:
+To ensure error data accuracy and relevance, RUM applies the following filtering rules:
 
 <AccordionGroup>
   <Accordion title="Default Filtering Rules">

en/rum/error-tracking/error-aggregation.mdx

@@ -1,6 +1,6 @@
 ---
 title: "Error Grouping"
-description: "Learn about Flashduty RUM error grouping mechanisms to improve Issue localization efficiency."
+description: "Learn about RUM error grouping mechanisms to improve Issue localization efficiency."
 ---
 
 When a new error event occurs, Flashduty uses a three-step aggregation strategy to group errors into Issues, effectively reducing the number of errors that need to be handled.

en/rum/error-tracking/error-reporting.mdx

@@ -1,13 +1,13 @@
 ---
 title: "Error Reporting"
-description: "Learn about Flashduty RUM's error reporting mechanism."
+description: "Learn about RUM's error reporting mechanism."
 ---
 
 This document covers exception types, capture mechanisms, manual reporting methods, React integration, and the data structure definition for reported exceptions.
 
 ## Exception Types
 
-Flashduty RUM can monitor the following types of exceptions:
+RUM can monitor the following types of exceptions:
 
 <Tabs>
   <Tab title="JavaScript Exceptions">
@@ -38,7 +38,7 @@ Flashduty RUM can monitor the following types of exceptions:
 
 ### Automatic Error Capture
 
-Flashduty RUM SDK automatically captures the following types of browser errors:
+RUM SDK automatically captures the following types of browser errors:
 
 | Error Type | Description |
 |----------|------|
@@ -96,7 +96,7 @@ try {
 
 ### React Error Boundary Integration
 
-Flashduty RUM supports capturing component rendering errors through React [Error Boundaries](https://legacy.reactjs.org/docs/error-boundaries.html) and reporting error information. You can call the `addError` API in `componentDidCatch`, attaching component stack information for debugging.
+RUM supports capturing component rendering errors through React [Error Boundaries](https://legacy.reactjs.org/docs/error-boundaries.html) and reporting error information. You can call the `addError` API in `componentDidCatch`, attaching component stack information for debugging.
 
 <Steps>
   <Step title="Create Error Boundary Component">
@@ -159,7 +159,7 @@ Each error record contains the following attributes to describe error details an
 
 ## Error Filtering and Configuration
 
-To ensure accuracy and relevance of error data, Flashduty RUM applies the following filtering rules:
+To ensure accuracy and relevance of error data, RUM applies the following filtering rules:
 
 <AccordionGroup>
   <Accordion title="Default Filtering Rules">

en/rum/error-tracking/error-viewing.mdx

@@ -1,9 +1,9 @@
 ---
 title: "Issue Overview and Details"
-description: "Master Flashduty RUM error tracking features to quickly discover and resolve website issues."
+description: "Master RUM error tracking features to quickly discover and resolve website issues."
 ---
 
-After errors are reported, you can view Issues in the Error Tracking module. In Flashduty RUM, an Issue is a group of similar errors, typically related to the same bug.
+After errors are reported, you can view Issues in the Error Tracking module. In RUM, an Issue is a group of similar errors, typically related to the same bug.
 
 <Frame>
   <img src="https://docs-cdn.flashcat.cloud/imges/png/7eaffcd3d631d03ffb553f8956ff94ac.png" alt="Issue List" />
@@ -70,7 +70,7 @@ For regression-related transition logic, please refer to [Issue Status](./issue-
     | Affected Sessions | Sort by number of affected RUM sessions |
   </Tab>
   <Tab title="Filters">
-    Flashduty RUM automatically indexes predefined attributes for your Issues and creates corresponding filters.
+    RUM automatically indexes predefined attributes for your Issues and creates corresponding filters.
 
     <Frame>
       <img src="https://docs-cdn.flashcat.cloud/imges/png/718ff0527731fd89465a3a7e0fb7c7ea.png" alt="Filters" />

en/rum/error-tracking/issue-alerts.mdx

@@ -1,9 +1,9 @@
 ---
 title: "Issue Alerts"
-description: "Learn how Flashduty RUM Issues trigger alerts"
+description: "Learn how RUM Issues trigger alerts"
 ---
 
-Flashduty RUM automatically aggregates all error events reported by the SDK into Issues, helping you prioritize and find the most impactful problems, making it easier to reduce service downtime and user frustration.
+RUM automatically aggregates all error events reported by the SDK into Issues, helping you prioritize and find the most impactful problems, making it easier to reduce service downtime and user frustration.
 
 You can inspect aggregated Issues through daily checks in the console, or configure alert notifications for Issues to be notified immediately when problems occur.
 

en/rum/error-tracking/issue-status.mdx

@@ -1,6 +1,6 @@
 ---
 title: "Issue Status"
-description: "Learn about Flashduty RUM Issue status transitions"
+description: "Learn about RUM Issue status transitions"
 ---
 
 In Error Tracking, all Issues have a status that helps you categorize and prioritize problems.