English | 中文
Official documentation for Flashduty, bilingual (Chinese & English), built with Mintlify. Covers On-call incident management, RUM real user monitoring, and Monitors alert rules — 390+ pages in total.
| Module | Description | Docs Path |
|---|---|---|
| On-call | Incident management, alert routing, escalation rules, schedule management | */on-call/ |
| RUM | Real User Monitoring, frontend performance and error tracking | */rum/ |
| Monitors | Multi-source alert rule configuration | */monitors/ |
| Platform | Account management, SSO, permissions, API keys | */platform/ |
| OpenAPI | REST API reference | */openapi/ |
npm i -g mintmint devVisit http://localhost:3000 to view the docs.
mint broken-linksRun this after every content change to catch dead links early.
We welcome community contributions! Whether it's fixing a typo, improving descriptions, or adding new documentation — every bit helps.
- Edit Chinese docs — Create or edit
.mdxfiles underzh/(Chinese is the source language) - Update navigation — Add the page path in
docs.jsonfor bothzhandensections - Translate to English — Create the corresponding file under
en/, keeping the path structure consistent - Validate links — Run
mint broken-linksto confirm no broken links
Every .mdx file must include:
---
title: "Clear, specific title"description: "Concise explanation of page purpose"
---- Use second person ("you")
- Use active voice, present tense
- Use sentence case for English titles (capitalize only first word)
- Leverage Mintlify components:
<Steps>,<Tabs>,<Note>,<Tip>,<Warning>,<Frame>,<CodeGroup>
flashduty-docs/
├── zh/ # Chinese docs (source of truth)
│ ├── on-call/ # On-call incident management
│ ├── rum/ # Real User Monitoring
│ ├── monitors/ # Alert rule configuration
│ ├── platform/ # Platform settings
│ ├── openapi/ # API documentation
│ ├── 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
Chinese is the source language; English is translated from it. When translating:
- Translate frontmatter
titleanddescription - Keep MDX component tags unchanged, translate inner text only
- Keep code blocks unchanged, translate comments only
- Update internal link paths from
zh/toen/ - Keep image paths unchanged
| Chinese | English |
|---|---|
| 协作空间 | channel |
| 故障 | incident |
| 分派策略 | escalation rule |
| 值班表 | schedule |
| 认领 | acknowledge |
| 静默策略 | silence rule |
| 抑制策略 | inhibit rule |
| 排除规则 | drop rule |
Full glossary: glossary.md
| Resource | Link |
|---|---|
| Flashduty Docs | docs.flashduty.com |
| Flashduty Console | console.flashcat.cloud |
| Flashduty Website | flashcat.cloud |
| MCP Server | flashduty-mcp-server |
| Terraform Provider | terraform-provider-flashduty |
| Mintlify Docs | mintlify.com/docs |
This project is licensed under the MIT License — see the LICENSE file for details.