Skip to content

docs: AI SRE docs — nav/homepage first positioning, quickstart & automations updates #289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ysyneu merged 10 commits into from
Aug 19, 2026
Merged

docs: AI SRE docs — nav/homepage first positioning, quickstart & automations updates #289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
05f4767
docs(ai-sre): quickstart — automatic incident analysis and BYOC Runne…
ysyneu Jul 22, 2026
fb17781
docs(ai-sre): document incident comment write-back; align template names
ysyneu Jul 22, 2026
4b0543c
Merge pull request #201 from flashcatcloud/feat/ai-sre-quickstart-add…
ysyneu Jul 22, 2026
4d91076
Merge remote-tracking branch 'origin/main' into feat-ai-sre-sync-test
ysyneu Aug 4, 2026
c788b5a
docs(ai-sre): mention On-call incident trigger in Automations overvie…
ysyneu Aug 14, 2026
fd0ddf6
Merge pull request #269 from flashcatcloud/fix/automations-card-triggers
ysyneu Aug 14, 2026
d6b93dd
docs: move AI SRE tab before On-call in top navigation
ysyneu Aug 19, 2026
bbb4fbc
Merge pull request #287 from flashcatcloud/docs/ai-sre-tab-first
ysyneu Aug 19, 2026
e2396c7
docs: put AI SRE first in homepage product intro and sidebar
ysyneu Aug 19, 2026
fd22c14
Merge pull request #288 from flashcatcloud/docs/ai-sre-home-first
ysyneu Aug 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
216 changes: 108 additions & 108 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1423,10 +1423,10 @@
"group": "产品简介",
"icon": "cubes",
"pages": [
"zh/ai-sre",
"zh/on-call",
"zh/rum",
"zh/monitors",
"zh/ai-sre"
"zh/monitors"
]
},
{
Expand Down Expand Up @@ -1477,6 +1477,58 @@
}
]
},
{
"tab": "AI SRE",
"icon": "sparkles",
"groups": [
{
"group": "快速开始",
"icon": "rocket",
"pages": [
"zh/ai-sre/quickstart",
"zh/ai-sre/overview",
"zh/ai-sre/init",
"zh/ai-sre/insight"
]
},
{
"group": "对话",
"icon": "comments",
"pages": [
"zh/ai-sre/sessions",
"zh/ai-sre/im",
"zh/ai-sre/automations",
"zh/ai-sre/artifacts"
]
},
{
"group": "插件",
"icon": "puzzle-piece",
"pages": [
"zh/ai-sre/mcp",
"zh/ai-sre/skills",
"zh/ai-sre/agents",
"zh/ai-sre/apps"
]
},
{
"group": "知识",
"icon": "book",
"pages": [
"zh/ai-sre/knowledge",
"zh/ai-sre/memory"
]
},
{
"group": "环境",
"icon": "server",
"pages": [
"zh/ai-sre/environments",
"zh/ai-sre/sandbox"
]
}
]
},
{
"tab": "On-call",
"icon": "light-emergency-on",
Expand Down Expand Up @@ -1956,58 +2008,6 @@
}
]
},
{
"tab": "AI SRE",
"icon": "sparkles",
"groups": [
{
"group": "快速开始",
"icon": "rocket",
"pages": [
"zh/ai-sre/quickstart",
"zh/ai-sre/overview",
"zh/ai-sre/init",
"zh/ai-sre/insight"
]
},
{
"group": "对话",
"icon": "comments",
"pages": [
"zh/ai-sre/sessions",
"zh/ai-sre/im",
"zh/ai-sre/automations",
"zh/ai-sre/artifacts"
]
},
{
"group": "插件",
"icon": "puzzle-piece",
"pages": [
"zh/ai-sre/mcp",
"zh/ai-sre/skills",
"zh/ai-sre/agents",
"zh/ai-sre/apps"
]
},
{
"group": "知识",
"icon": "book",
"pages": [
"zh/ai-sre/knowledge",
"zh/ai-sre/memory"
]
},
{
"group": "环境",
"icon": "server",
"pages": [
"zh/ai-sre/environments",
"zh/ai-sre/sandbox"
]
}
]
},
{
"tab": "API 参考",
"icon": "terminal",
Expand Down Expand Up @@ -2774,10 +2774,10 @@
"group": "Products",
"icon": "cubes",
"pages": [
"en/ai-sre",
"en/on-call",
"en/rum",
"en/monitors",
"en/ai-sre"
"en/monitors"
]
},
{
Expand Down Expand Up @@ -2828,6 +2828,58 @@
}
]
},
{
"tab": "AI SRE",
"icon": "sparkles",
"groups": [
{
"group": "Quick Start",
"icon": "rocket",
"pages": [
"en/ai-sre/quickstart",
"en/ai-sre/overview",
"en/ai-sre/init",
"en/ai-sre/insight"
]
},
{
"group": "Chat",
"icon": "comments",
"pages": [
"en/ai-sre/sessions",
"en/ai-sre/im",
"en/ai-sre/automations",
"en/ai-sre/artifacts"
]
},
{
"group": "Plugins",
"icon": "puzzle-piece",
"pages": [
"en/ai-sre/mcp",
"en/ai-sre/skills",
"en/ai-sre/agents",
"en/ai-sre/apps"
]
},
{
"group": "Knowledge",
"icon": "book",
"pages": [
"en/ai-sre/knowledge",
"en/ai-sre/memory"
]
},
{
"group": "Environments",
"icon": "server",
"pages": [
"en/ai-sre/environments",
"en/ai-sre/sandbox"
]
}
]
},
{
"tab": "On-call",
"icon": "light-emergency-on",
Expand Down Expand Up @@ -3307,58 +3359,6 @@
}
]
},
{
"tab": "AI SRE",
"icon": "sparkles",
"groups": [
{
"group": "Quick Start",
"icon": "rocket",
"pages": [
"en/ai-sre/quickstart",
"en/ai-sre/overview",
"en/ai-sre/init",
"en/ai-sre/insight"
]
},
{
"group": "Chat",
"icon": "comments",
"pages": [
"en/ai-sre/sessions",
"en/ai-sre/im",
"en/ai-sre/automations",
"en/ai-sre/artifacts"
]
},
{
"group": "Plugins",
"icon": "puzzle-piece",
"pages": [
"en/ai-sre/mcp",
"en/ai-sre/skills",
"en/ai-sre/agents",
"en/ai-sre/apps"
]
},
{
"group": "Knowledge",
"icon": "book",
"pages": [
"en/ai-sre/knowledge",
"en/ai-sre/memory"
]
},
{
"group": "Environments",
"icon": "server",
"pages": [
"en/ai-sre/environments",
"en/ai-sre/sandbox"
]
}
]
},
{
"tab": "API Reference",
"icon": "terminal",
Expand Down
4 changes: 3 additions & 1 deletion en/ai-sre/automations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The page header offers two creation entry points: an outline-style **Create via
Choose **Start from scratch** to open a blank form and manually fill in the name, task prompt, and triggers. This suits cases where you already know what you want the agent to do and want a fully custom prompt.
</Step>
<Step title="From a preset template">
Below, a set of **preset template** cards is listed (delivered by the backend per UI language: `zh-CN` for Chinese, `en-US` for English). Common ones include **Alert Noise Analysis**, **Incident Response Review**, **Weekly On-call Insights**, and **Escalation and On-call Load Analysis**. Click any template card to prefill the form with the template's name and task prompt; tweak from there.
Below, a set of **preset template** cards is listed (delivered by the backend per UI language: `zh-CN` for Chinese, `en-US` for English). Common ones include **Weekly Insights**, **Alert Governance**, **On-call Incident Analysis**, and **On-call Load Analysis**. Click any template card to prefill the form with the template's name and task prompt; tweak from there.
</Step>
</Steps>

Expand Down Expand Up @@ -170,6 +170,8 @@ If you create or update a rule through the API, use these fields:

When a matching event arrives, the system creates a run with `trigger_kind: "oncall_incident"` and passes event context such as `incident_id`, `channel_id`, and `severity` into the session. The same trigger and the same `incident_id` reuse the same run, avoiding duplicate hidden sessions for one incident.

When the run finishes, AI SRE writes one summary comment back to the incident that triggered it: conclusion first, body kept concise, with a link to the full session at the end. The comment travels through the incident's existing notification chain (for example, incident card refreshes and thread replies in IM), so whoever is watching the incident sees the analysis without opening the console. This applies to every rule with the On-call incident trigger enabled — including rules with custom prompts — with no extra configuration.

## Run History

---
Expand Down
35 changes: 30 additions & 5 deletions en/ai-sre/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Complete Your First AI SRE Investigation in 15 Minutes
description: Start with a real incident and get your first AI SRE investigation — grounded in context, backed by evidence, and open to follow-up questions — then build team knowledge and connect real data sources as needed.
keywords: ["AI SRE", "Quickstart", "incident investigation", "/init", "knowledge base", "MCP", "BYOC Runner"]
description: Start with a real incident and get your first AI SRE investigation — grounded in context, backed by evidence, and open to follow-up questions — then get every new incident analyzed automatically, build team knowledge, and deploy a BYOC Runner to reach real data sources.
keywords: ["AI SRE", "Quickstart", "incident investigation", "automatic incident analysis", "/init", "knowledge base", "MCP", "BYOC Runner"]
sidebarTitle: Quick Start
---

Expand Down Expand Up @@ -34,7 +34,7 @@ For actively investigating an issue, digging deeper, or building up knowledge. G

### Automations

For work that shouldn't need a human watching it — scheduled inspections, weekly insight reports, alert-noise cleanup. Go to **AI SRE → Automations** and create one from a built-in template (Alert Noise Analysis, Incident Response Review, Weekly On-call Insights, and more) or build one from scratch. Each run happens in a hidden session in the background, and the result lands in the run history where you can open the full trail any time. → See [Automations](/en/ai-sre/automations)
For work that shouldn't need a human watching it — scheduled inspections, weekly insight reports, alert-noise cleanup. Go to **AI SRE → Automations** and create one from a built-in template (On-call Incident Analysis, Alert Governance, Weekly Insights, and more) or build one from scratch. Each run happens in a hidden session in the background, and the result lands in the run history where you can open the full trail any time. → See [Automations](/en/ai-sre/automations)

### IM (@ Mentions + Automatic War Room Diagnosis)

Expand Down Expand Up @@ -82,15 +82,40 @@ If you don't have an incident on hand right now, skip ahead to "Growing It Into

---

Your first investigation is just the starting point. How well AI SRE diagnoses depends on how much it knows about your systems and how much real data it can reach — both are things you build up over time, not all at once.
Your first investigation is just the starting point. From here you can make analysis automatic, and keep sharpening its diagnoses — the latter depends on how much it knows about your systems and how much real data it can reach. All of this builds up over time, not all at once.

### Get every new incident analyzed automatically

Once manual investigations feel routine, make them the default: go to **AI SRE → Automations**, create a rule from the built-in **On-call Incident Analysis** template, enable the **On-call incident** trigger card, and pick the channels and severities to watch. From then on, every matching new incident gets an automatic investigation, and AI SRE writes one summary comment back to the incident — conclusion first, full session link at the end — delivered through the incident's existing notification channels, so responders see the first analysis right in IM. Configuration details: [Automations · On-call Incident Trigger](/en/ai-sre/automations#on-call-incident-trigger).

This is independent of war room auto-diagnosis: this path fires for every matching new incident and writes back to the incident itself; war room diagnosis runs when you open a war room for an incident and posts into the war room group (see [IM](/en/ai-sre/im)).

### Build a team knowledge base

If the agent has to guess "what service is this," "who owns it," and "how was this handled last time" on every investigation, it won't get much sharper. Type `/init` in a session and the agent interviews you to map out your services, runbooks, on-call routing, and more — confirming each write before it saves anything, and loading it automatically in future sessions. See the full interview flow in [Setup (/init)](/en/ai-sre/init) and the knowledge base structure and best practices in [Knowledge](/en/ai-sre/knowledge).

### Connect real data sources

By default the agent only sees Flashduty's own data. To let it query your actual systems — logs, metrics, code repositories, internal databases — connect an MCP server or deploy a BYOC Runner. Publicly reachable services (observability platforms, GitHub, and similar) install and authorize in one click from the MCP directory; VPCs, internal databases, or local commands need a Runner deployed on a machine that can reach them. See [MCP](/en/ai-sre/mcp) and [Environments](/en/ai-sre/environments).
By default the agent only sees Flashduty's own data. To let it query your actual systems — logs, metrics, code repositories, internal databases — connect an MCP server or deploy a BYOC Runner. Publicly reachable services (observability platforms, GitHub, and similar) install and authorize in one click from the MCP directory — see [MCP](/en/ai-sre/mcp); VPCs, internal databases, or local commands need a Runner deployed on a machine that can reach them — about three minutes, below.

### Deploy a BYOC Runner (~3 minutes)

<Steps>
<Step title="Create a self-hosted Environment">
Go to **AI SRE → Environments** and click **Create** on the **Self-hosted** tab. The name is optional (the first heartbeat fills it in with the machine's hostname); pick account or team scope.
</Step>
<Step title="Run the install command on the target machine">
After creation, the **setup guide** opens with install commands that already include your Token — a Linux one-liner (needs sudo; registers a systemd service), plus Docker and macOS variants. Copy it onto a machine that can reach your target resources and run it.
</Step>
<Step title="Wait for the status to flip to Online">
Back in the list, the status goes from **Pending** to **Online** once connected. Heartbeats are evaluated on a ~90-second cycle, so give it a moment after installing; if it stays Pending, the machine almost certainly can't reach the connect URL shown in the guide (outbound traffic blocked by a firewall).
</Step>
<Step title="Use it in a session">
When starting a new chat, the environment picker at the bottom of the composer defaults to **Auto** — it prefers an online Runner when one is available; you can also select this self-hosted Environment explicitly. Note that the environment locks once the session starts and cannot be changed afterwards.
</Step>
</Steps>

Permission rules (limiting what the agent may do on that machine), upgrades, and uninstallation: see [Environments](/en/ai-sre/environments).

## What's Next

Expand Down
Loading