Skip to content

Latest commit

 

History

History
120 lines (86 loc) · 2.77 KB

README.en.md

File metadata and controls

120 lines (86 loc) · 2.77 KB

Flashduty Documentation

English | 中文

Official documentation for Flashduty, built with Mintlify.

Directory Structure

flashduty-docs/
├── zh/                    # Chinese documentation
│   ├── 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 documentation (mirrors zh/)
├── logo/                  # Logo assets
├── docs.json              # Mintlify configuration
└── .cursor/skills/        # AI Agent Skills

Product Modules

Module Description
On-call Incident management, alert routing, escalation rules, schedule management
RUM Real User Monitoring, frontend performance and error tracking
Monitors Multi-source alert rule configuration

Local Development

Prerequisites

npm i -g mint

Common Commands

# Local preview
mint dev

# Check broken links
mint broken-links

Adding Documentation

1. Create Document

Create .mdx file in the appropriate directory:

---
title: "Clear, specific title"
description: "Concise explanation of page purpose"
---

2. Update Navigation

Add page path in docs.json:

{
  "group": "Quick Start",
  "pages": ["en/on-call/quickstart/quickstart"]
}

3. Bilingual Sync

  • Maintain consistent structure between Chinese and English
  • English docs go in en/ directory, mirroring zh/ paths
  • Use translate-zh-to-en Skill for translation

Writing Guidelines

Style

  • Use second person ("you")
  • Use active voice
  • Keep it concise and direct

Common Components

Component Purpose
<Steps> Step-by-step instructions
<Tabs> Platform-specific content
<CodeGroup> Multi-language code
<Note> / <Tip> / <Warning> Callouts
<Frame> Image container

Code Examples

  • Provide complete, runnable examples
  • Specify language and filename
  • Never include real API keys

AI Assistance

This project provides two AI Skills:

Skill Purpose
translate-zh-to-en Translate Chinese docs to English
polish-document Polish and optimize documentation

See AGENTS.md for details.

Links