Skip to content

Commit b59be15

Browse files
authored
Merge pull request #186 from flashcatcloud/codex/mintlify-seo
docs: optimize Mintlify SEO and canonical URLs
2 parents 34bac42 + fe18f9f commit b59be15

91 files changed

Lines changed: 191 additions & 115 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
English | [中文](https://github.com/flashcatcloud/flashduty-docs/blob/main/README_zh.md)
44

55
[![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)
6+
[![Docs](https://img.shields.io/badge/Live-docs.flashduty.com-blue?style=flat-square)](https://docs.flashduty.com)
77
[![License: MIT](https://img.shields.io/badge/License-MIT-green?style=flat-square)](LICENSE)
88

99
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.
@@ -131,7 +131,7 @@ Full glossary: [`glossary.md`](glossary.md)
131131

132132
| Resource | Link |
133133
|----------|------|
134-
| Flashduty Docs | [docs.flashcat.cloud](https://docs.flashcat.cloud) |
134+
| Flashduty Docs | [docs.flashduty.com](https://docs.flashduty.com) |
135135
| Flashduty Console | [console.flashcat.cloud](https://console.flashcat.cloud/) |
136136
| Flashduty Website | [flashcat.cloud](https://flashcat.cloud/) |
137137
| MCP Server | [flashduty-mcp-server](https://github.com/flashcatcloud/flashduty-mcp-server) |

README_zh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[English](https://github.com/flashcatcloud/flashduty-docs/blob/main/README.md) | 中文
44

55
[![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)
6+
[![Docs](https://img.shields.io/badge/Live-docs.flashduty.com-blue?style=flat-square)](https://docs.flashduty.com)
77
[![License: MIT](https://img.shields.io/badge/License-MIT-green?style=flat-square)](LICENSE)
88

99
[Flashduty](https://flashcat.cloud/) 官方文档站,中英双语,基于 [Mintlify](https://mintlify.com/) 构建。覆盖 On-call 故障管理、RUM 真实用户监控、Monitors 告警规则三大产品模块,共 **390+** 页文档。
@@ -131,7 +131,7 @@ flashduty-docs/
131131

132132
| 资源 | 链接 |
133133
|------|------|
134-
| Flashduty 文档站 | [docs.flashcat.cloud](https://docs.flashcat.cloud) |
134+
| Flashduty 文档站 | [docs.flashduty.com](https://docs.flashduty.com) |
135135
| Flashduty 控制台 | [console.flashcat.cloud](https://console.flashcat.cloud/) |
136136
| Flashduty 官网 | [flashcat.cloud](https://flashcat.cloud/) |
137137
| MCP Server | [flashduty-mcp-server](https://github.com/flashcatcloud/flashduty-mcp-server) |

api-reference/openapi.legacy.zh.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12690,7 +12690,7 @@
1269012690
},
1269112691
"include_events": {
1269212692
"type": "boolean",
12693-
"description": "是否包含原始事件数据,了解[告警降噪](https://docs.flashcat.cloud/zh/flashduty/what-is-noise-reduction#%E5%9F%BA%E6%9C%AC%E6%A6%82%E5%BF%B5)"
12693+
"description": "是否包含原始事件数据,了解[告警降噪](https://docs.flashduty.com/zh/flashduty/what-is-noise-reduction#%E5%9F%BA%E6%9C%AC%E6%A6%82%E5%BF%B5)"
1269412694
},
1269512695
"is_active": {
1269612696
"type": [
@@ -28766,7 +28766,7 @@
2876628766
},
2876728767
"title_rule": {
2876828768
"type": "string",
28769-
"description": "告警标题生成规则,具体请[参考规则](https://docs.flashcat.cloud/zh/flashduty/customize-incident-attrs)"
28769+
"description": "告警标题生成规则,具体请[参考规则](https://docs.flashduty.com/zh/flashduty/customize-incident-attrs)"
2877028770
},
2877128771
"description": {
2877228772
"type": "string",
@@ -30678,7 +30678,7 @@
3067830678
"title": "新的告警标题",
3067930679
"minLength": 1,
3068030680
"maxLength": 512,
30681-
"description": "支持通过变量生成,参考[定制故障标题](https://docs.flashcat.cloud/zh/flashduty/customize-incident-attrs)"
30681+
"description": "支持通过变量生成,参考[定制故障标题](https://docs.flashduty.com/zh/flashduty/customize-incident-attrs)"
3068230682
}
3068330683
},
3068430684
"required": [
@@ -30691,7 +30691,7 @@
3069130691
"description": {
3069230692
"type": "string",
3069330693
"title": "新的告警描述",
30694-
"description": "支持通过变量生成,参考[定制故障描述](https://docs.flashcat.cloud/zh/flashduty/customize-incident-attrs)",
30694+
"description": "支持通过变量生成,参考[定制故障描述](https://docs.flashduty.com/zh/flashduty/customize-incident-attrs)",
3069530695
"minLength": 1,
3069630696
"maxLength": 2048
3069730697
}
@@ -30706,7 +30706,7 @@
3070630706
"severity": {
3070730707
"type": "string",
3070830708
"title": "新的严重程度",
30709-
"description": "支持通过变量生成,参考[定制故障描述](https://docs.flashcat.cloud/zh/flashduty/customize-incident-attrs)",
30709+
"description": "支持通过变量生成,参考[定制故障描述](https://docs.flashduty.com/zh/flashduty/customize-incident-attrs)",
3071030710
"enum": [
3071130711
"Critical",
3071230712
"Warning",
@@ -33283,4 +33283,4 @@
3328333283
}
3328433284
],
3328533285
"security": []
33286-
}
33286+
}

docs.json

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"$schema": "https://mintlify.com/docs.json",
3+
"description": "Flashduty 官方文档,涵盖 On-call 告警响应、Monitors 监控、RUM 与 AI SRE 的配置指南、集成方式和 API 参考。",
34
"theme": "mint",
45
"name": "Flashduty Docs",
56
"favicon": "/logo/saas-favicon.png",
@@ -15,7 +16,17 @@
1516
},
1617
"seo": {
1718
"metatags": {
18-
"canonical": "https://docs.flashcat.cloud"
19+
"canonical": "https://docs.flashduty.com"
20+
},
21+
"organization": {
22+
"id": "https://flashduty.com/#organization",
23+
"name": "Flashduty",
24+
"legalName": "北京快猫星云科技有限公司",
25+
"url": "https://flashduty.com/",
26+
"logo": "https://docs.flashduty.com/logo/saas-logo.svg",
27+
"sameAs": [
28+
"https://github.com/flashcatcloud"
29+
]
1930
}
2031
},
2132
"redirects": [

en/ai-sre/init.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Type `/init` in the input box of any AI SRE session, and the agent switches into
1818
`/init` is the **starting point** for the knowledge base. AI SRE's diagnostic quality depends directly on how much real knowledge it can read about your systems: the more complete and accurate your [Knowledge](/en/ai-sre/knowledge) base is, the faster and more reliably the agent pinpoints root causes. `/init` is the guided flow that builds that knowledge from zero — and once it's built, every session loads it automatically.
1919

2020
<Note>
21-
`/init` will **never** write or install anything without your consent. Before anything lands at each phase, it lists exactly "which files will be created/updated," and only acts after you confirm them one by one. Credentials (tokens, passwords, AK/SK) are never echoed back in plain text in the conversation — only recorded as `<recorded (length=N)>`. See [Safety & consent](#safety--consent).
21+
`/init` will **never** write or install anything without your consent. Before anything lands at each phase, it lists exactly "which files will be created/updated," and only acts after you confirm them one by one. Credentials (tokens, passwords, AK/SK) are never echoed back in plain text in the conversation — only recorded as `<recorded (length=N)>`. See [Safety and consent](#safety-and-consent).
2222
</Note>
2323

2424
## When to use /init vs. plain natural language
@@ -98,7 +98,7 @@ Type `/init` in the input box of any AI SRE session, and the agent switches into
9898
</Accordion>
9999
</AccordionGroup>
100100

101-
## Safety & consent
101+
## Safety and consent
102102

103103
---
104104

en/compliance/user-agreement.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "User Agreement"
3-
description: "Learn about the Flashduty Terms of Service from Beijing Flashcat Cloud Technology Co.,Ltd."
3+
description: "Review the legal terms governing user registration, account management, and use of Flashduty services."
44
---
55

66
Last Updated: 2022-12-24
@@ -365,4 +365,4 @@ When the following circumstances occur, the Flashcat Cloud service system may no
365365

366366
13.2 This Agreement takes effect after you click "Agree to Agreement and Submit" (specific wording detailed on the registration page) on the Flashcat Cloud platform, and unless otherwise agreed by both parties, this Agreement will remain valid during your use of Flashcat Cloud services.
367367

368-
13.3 The effectiveness, interpretation, modification, execution, and dispute resolution of this Agreement are governed by the laws of the People's Republic of China. Any disputes arising from or related to this Agreement shall be submitted to the People's Court of Haidian District, Beijing for adjudication.
368+
13.3 The effectiveness, interpretation, modification, execution, and dispute resolution of this Agreement are governed by the laws of the People's Republic of China. Any disputes arising from or related to this Agreement shall be submitted to the People's Court of Haidian District, Beijing for adjudication.

en/developer/go-sdk.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Go SDK
2+
title: Flashduty Go SDK
33
sidebarTitle: Go SDK
44
description: "go-flashduty is the official open-source Go SDK for Flashduty — a typed, strictly 1:1 wrapper over the Open API currently covering all 288 API operations across 32 services."
55
keywords: ["Go SDK", "go-flashduty", "Open API", "Golang", "client"]

en/monitors/faq/faq.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: "FAQ"
2+
title: "Flashduty Monitors FAQ"
3+
sidebarTitle: "FAQ"
34
description: "Monitors frequently asked questions"
45
---
56

en/monitors/quickstart/quickstart.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: "Getting Started"
2+
title: "Flashduty Monitors Getting Started"
3+
sidebarTitle: "Getting Started"
34
description: "Monitors quick start guide to help you get started with alerting"
45
---
56

en/on-call/channel/escalation-rule.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Determines how users are reached.
7575
- **Group Bots**: Supports Feishu/Lark, Dingtalk, WeCom, Telegram, Zoom, and other Webhook bots. Telegram requires configuring a Webhook notification address and Chat IDs, Zoom requires configuring a Webhook address and Verify Token, and supports enabling @ mention functionality. See [Notification Channel Configuration](/en/on-call/configuration/notifications)
7676

7777
<Note>
78-
**Don't use any of the above IM platforms?** You can select any bot type and set the webhook URL to your own server endpoint (the system does not validate domains), then implement the corresponding message protocol on your server. See [FAQ](/en/on-call/quickstart/faq#i-dont-use-feishudingtalkwecomtelegram--how-can-i-receive-bot-notifications).
78+
**Don't use any of the above IM platforms?** You can select any bot type and set the webhook URL to your own server endpoint (the system does not validate domains), then implement the corresponding message protocol on your server. See [FAQ](/en/on-call/quickstart/faq#custom-bot-notifications).
7979
</Note>
8080
</Tab>
8181
</Tabs>

0 commit comments

Comments
 (0)