Skip to content

Commit f8bc87a

Browse files
authored
Merge pull request #1013 from flashcatcloud/release/ai-sre-docs-20261006
docs(ai-sre): Knowledge naming and Customize navigation
2 parents f9d18ff + 717e918 commit f8bc87a

37 files changed

Lines changed: 350 additions & 265 deletions

‎.claude/skills/translate-zh-to-en/glossary.md‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ string to preserve verbatim when generating Chinese translations.
174174
Style rule: when a DNT term appears mid-sentence in Chinese, surround it with
175175
a single half-width space on either side (e.g., `管理你的 Routines`, not
176176
`管理你的Routines`). For multi-word terms, keep them together verbatim
177-
(e.g., `创建 Knowledge Pack`).
177+
(e.g., `创建 A2A Agent`).
178178

179179
| Term | Notes |
180180
|------|-------|
@@ -186,12 +186,10 @@ a single half-width space on either side (e.g., `管理你的 Routines`, not
186186
| Automation | User-defined automation trigger + action |
187187
| Runner | Agent execution backend (e.g., `flashduty-runner`) |
188188
| A2A | Agent-to-Agent protocol |
189-
| Knowledge Pack | A curated knowledge bundle attached to an Agent |
190189
| Tool call | A single tool invocation inside an Agent turn |
191190
| Slash command | UI slash-prefixed command (e.g., `/help`) |
192191
| Reasoning | The reasoning / chain-of-thought block of a model response |
193192
| Connector | Integration with an external system (Slack, GitHub, etc.) |
194-
| Environment | Execution environment for runners (env vars, credentials) |
195193
| Todo | The Todo list shown in agent UI |
196194
| Mermaid | Mermaid diagram syntax |
197195
| Prompt | System or user prompt sent to a model |
@@ -201,6 +199,14 @@ Translatable companions (do NOT belong in DNT — translate to Chinese):
201199
| English | Chinese |
202200
|---------|---------|
203201
| Artifact / Artifacts | 产物 |
202+
| Knowledge | 知识库 — the DUTY.md-rooted file tree an account or team maintains for AI SRE. Formerly "Knowledge Pack"; do not use that name in copy. Running text uses lowercase "knowledge" (e.g., "team knowledge"); API identifiers such as `pack_id` and `knowledge-pack-*` CLI commands stay unchanged |
203+
| Memory | 记忆 |
204+
| Context | 上下文 — the Customize group holding Knowledge and Memory |
205+
| Customize | 自定义 — the AI SRE sidebar entry that opens Context, Plugins, and Environments |
206+
| Plugins | 插件 |
207+
| Environment / Environments | 环境 |
208+
| Self-hosted | 自托管 |
209+
| Cloud | 云端 |
204210

205211
## Intentional Variants (per-context wording)
206212

@@ -217,7 +223,6 @@ Translators: pick the variant whose context matches.
217223
| 成功 | Succeeded (run-status filter) / OK (compact badge) |
218224
| 对话 | Chat (singular) / Chats (section header, plural) |
219225
| 环境 | Environment (field label) / Environments (nav or page title, plural) |
220-
| 知识库 | Knowledge Pack (singular) / Knowledge Packs (page title, plural) |
221226
| 产物 | Artifact (singular) / Artifacts (plural) |
222227
| 文档 | Document (artifact kind) / Documentation (docs link) |
223228
| 邮件 | Email (channel label, pairs with "SMS") / Email us (CTA, pairs with "Call us") |

‎docs.json‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1526,16 +1526,6 @@
15261526
"zh/ai-sre/artifacts"
15271527
]
15281528
},
1529-
{
1530-
"group": "插件",
1531-
"icon": "puzzle-piece",
1532-
"pages": [
1533-
"zh/ai-sre/mcp",
1534-
"zh/ai-sre/skills",
1535-
"zh/ai-sre/agents",
1536-
"zh/ai-sre/apps"
1537-
]
1538-
},
15391529
{
15401530
"group": "上下文",
15411531
"icon": "book",
@@ -1545,6 +1535,16 @@
15451535
"zh/ai-sre/memory"
15461536
]
15471537
},
1538+
{
1539+
"group": "插件",
1540+
"icon": "puzzle-piece",
1541+
"pages": [
1542+
"zh/ai-sre/apps",
1543+
"zh/ai-sre/skills",
1544+
"zh/ai-sre/mcp",
1545+
"zh/ai-sre/agents"
1546+
]
1547+
},
15481548
{
15491549
"group": "环境",
15501550
"icon": "server",
@@ -3162,16 +3162,6 @@
31623162
"en/ai-sre/artifacts"
31633163
]
31643164
},
3165-
{
3166-
"group": "Plugins",
3167-
"icon": "puzzle-piece",
3168-
"pages": [
3169-
"en/ai-sre/mcp",
3170-
"en/ai-sre/skills",
3171-
"en/ai-sre/agents",
3172-
"en/ai-sre/apps"
3173-
]
3174-
},
31753165
{
31763166
"group": "Context",
31773167
"icon": "book",
@@ -3181,6 +3171,16 @@
31813171
"en/ai-sre/memory"
31823172
]
31833173
},
3174+
{
3175+
"group": "Plugins",
3176+
"icon": "puzzle-piece",
3177+
"pages": [
3178+
"en/ai-sre/apps",
3179+
"en/ai-sre/skills",
3180+
"en/ai-sre/mcp",
3181+
"en/ai-sre/agents"
3182+
]
3183+
},
31843184
{
31853185
"group": "Environments",
31863186
"icon": "server",

‎en/ai-sre.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ It is not a question-and-answer chatbot but a **hands-on troubleshooter**, integ
2525
Spin up a session from an incident or war room; the Agent carries the context in, and accumulated knowledge feeds the next response
2626
</Card>
2727
<Card title="Knowledge that compounds" icon="book">
28-
DUTY.md-rooted Knowledge Packs hold service catalogs, runbooks, on-call paths, and other long-lived context
28+
DUTY.md-rooted knowledge holds service catalogs, runbooks, on-call paths, and other long-lived context
2929
</Card>
3030
<Card title="An extensible tool ecosystem" icon="plug">
3131
Extend capabilities with Skills, MCP, and A2A Agents; self-hosted Runners bring troubleshooting into your own network

‎en/ai-sre/agents.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Delegation does not make you wait: after AI SRE hands a task to a remote agent,
3030
**Instructions have two levels and act as the agent-selection signal.** Before delegating, AI SRE sees a list of available agents where each entry is just `name: summary` — the summary comes from a `summary:` line at the top of the instructions (if omitted, the beginning of the body is excerpted automatically). AI SRE uses it to decide **whether and when** to delegate to this agent, so state clearly when to prefer it, what it excels at, and what it is not suited for. The body that follows the summary is not kept in the list — it is delivered to AI SRE in full only the **first time it delegates to this agent**, so you can write it as long and detailed as needed (procedures, hard rules, examples) without slowing down everyday conversations. See "[Writing Instructions](#writing-instructions)" below for the format.
3131
</Tip>
3232

33-
The A2A agent list and management entry point are on the **Plugins → Agents** page (menu tab labeled **Agents**).
33+
The A2A agent list and management entry point are on the **Customize → Plugins → Agents** page (menu tab labeled **Agents**).
3434

3535
<Note>
3636
**Agents covers two distinct concepts.** This page (Agents) currently manages **A2A Agents** (external agent-to-agent calls). The other concept is the **Subagent** — a platform-built-in task executor that AI SRE dispatches on demand within a session. Subagents have no create / edit entry point; you only observe their behavior in sessions. See "[Subagent](#subagent)" below.
@@ -279,7 +279,7 @@ When a session **enters via an incident route** (e.g., AI SRE is triggered from
279279

280280
---
281281

282-
The full lifecycle of A2A agents is managed on the **Plugins → Agents** page.
282+
The full lifecycle of A2A agents is managed on the **Customize → Plugins → Agents** page.
283283

284284
<AccordionGroup>
285285
<Accordion title="Create" icon="plus">
@@ -303,7 +303,7 @@ The full lifecycle of A2A agents is managed on the **Plugins → Agents** page.
303303

304304
---
305305

306-
A2A agents share the same **two-level scope** model as other resources (skills, Knowledge Packs, MCP, environments), divided into account level and team level. In the console UI, the account-level option is labeled "**Shared**" / "**Shared scope**" — synonymous with account level (visible account-wide):
306+
A2A agents share the same **two-level scope** model as other resources (skills, Knowledge, MCP, environments), divided into account level and team level. In the console UI, the account-level option is labeled "**Shared**" / "**Shared scope**" — synonymous with account level (visible account-wide):
307307

308308
| Scope | Visibility |
309309
| --- | --- |
@@ -328,7 +328,7 @@ A2A agents share the same **two-level scope** model as other resources (skills,
328328
Connect external tools to agents to expand their capability boundary during tasks.
329329
</Card>
330330
<Card title="Manage Knowledge" icon="book" href="/en/ai-sre/knowledge">
331-
Use DUTY.md and Knowledge Packs to provide agents with team context and troubleshooting experience.
331+
Use DUTY.md and knowledge to provide agents with team context and troubleshooting experience.
332332
</Card>
333333
<Card title="IM Platform" icon="comment-dots" href="/en/ai-sre/im">
334334
@ AI SRE in an IM group and learn about automatic war-room incident diagnosis.

‎en/ai-sre/apps.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ AI SRE sessions run in a **Flashduty cloud sandbox** by default. The sandbox is
3131

3232
---
3333

34-
Go to **Plugins → Apps**. Opening the Plugins area lands on the **Overview** tab by default; Apps is one of its tabs (the tab order is Overview / Apps / Skill / MCP / Agents).
34+
Go to **AI SRE → Customize → Plugins → Apps**. The Plugins group in the Customize sidebar lists Overview / Apps / Skill / MCP / Agents in that order, and clicking **Customize** opens **Overview** by default.
3535

3636
<Note>
37-
Viewing the Apps tab requires the appropriate permission; without it, the tab is hidden. Authorizing, disconnecting / revoking, and enabling / disabling each require their own action permission — when you lack one, the corresponding button is shown disabled.
37+
Viewing the Apps page requires the appropriate permission; without it, the entry is hidden from the sidebar. Authorizing, disconnecting / revoking, and enabling / disabling each require their own action permission — when you lack one, the corresponding button is shown disabled.
3838
</Note>
3939

4040
## Kubernetes Apps
@@ -47,7 +47,7 @@ A Kubernetes App connects an in-cluster agent to AI SRE. After installation, AI
4747

4848
<Steps>
4949
<Step title="Create a Kubernetes App">
50-
Go to **Plugins → Apps → Kubernetes Apps** and click **Create Kubernetes App**. Enter a cluster name and choose its scope: **Shared** is available to all sessions in the account; **Team** is available to that team's sessions and to personal sessions of its members. Cluster names must be unique within a scope.
50+
Go to **Customize → Plugins → Apps → Kubernetes Apps** and click **Create Kubernetes App**. Enter a cluster name and choose its scope: **Shared** is available to all sessions in the account; **Team** is available to that team's sessions and to personal sessions of its members. Cluster names must be unique within a scope.
5151
</Step>
5252
<Step title="Set namespace access">
5353
Choose **All namespaces** or **Specific namespaces**. All namespaces applies one permission level to current and future namespaces. With specific namespaces, set **Read-only**, **Read + limited modifications**, or **Full access** for each namespace. Leaving the specific-namespace list empty allows the agent to read only basic cluster metadata. **Full access** is the highest level within the namespace: on a specific namespace it applies only inside that namespace (cluster metadata stays read-only), while **All namespaces + Full access** grants `cluster-admin` via a `ClusterRoleBinding`, including cluster-scoped resources and cluster RBAC (available only with All namespaces). See [Permission details](#permission-details) below for what each level can do; open **View Kubernetes RBAC details** in the form for the complete RBAC rules.
@@ -142,10 +142,10 @@ Each authorized organization adds one installation row under the GitHub card. Ea
142142

143143
### Adding or Adjusting Repository Access
144144

145-
The organization is already connected, but you want AI SRE to reach more of its repositories — you don't need to revoke and reconnect. In **Plugins → Apps**, click **More repositories** again for that organization (or open the App's **Configure** page on GitHub directly). GitHub shows the **Repository access** screen; select the additional repositories and save, and AI SRE **re-syncs** the granted repository list automatically — the new repositories become available without re-creating the connection.
145+
The organization is already connected, but you want AI SRE to reach more of its repositories — you don't need to revoke and reconnect. In **Customize → Plugins → Apps**, click **More repositories** again for that organization (or open the App's **Configure** page on GitHub directly). GitHub shows the **Repository access** screen; select the additional repositories and save, and AI SRE **re-syncs** the granted repository list automatically — the new repositories become available without re-creating the connection.
146146

147147
<Note>
148-
**Fallback**: if a newly added repository still reports "cannot access / 404 / 403" in a session, open the App's page on GitHub (e.g. `github.com/apps/flashduty`) → **Configure** → select the organization → scroll to the **Danger zone** → **Uninstall**. Then return to **Plugins → Apps** in Flashduty and authorize the organization again, granting **all** the repositories you need in one pass.
148+
**Fallback**: if a newly added repository still reports "cannot access / 404 / 403" in a session, open the App's page on GitHub (e.g. `github.com/apps/flashduty`) → **Configure** → select the organization → scroll to the **Danger zone** → **Uninstall**. Then return to **Customize → Plugins → Apps** in Flashduty and authorize the organization again, granting **all** the repositories you need in one pass.
149149
</Note>
150150

151151
## The GitLab App
@@ -226,7 +226,7 @@ After authorization, you need no extra configuration. When you ask AI SRE to wor
226226
- Never delete branches, close others' issues / PRs / MRs, or change repository settings; never commit secrets, credentials, or build artifacts.
227227

228228
<Note>
229-
If the agent reports it cannot access a repository in a cloud session, it usually means the account has not authorized the relevant App (GitHub or GitLab), or the target repository / group was not granted — just authorize and grant it under **Plugins → Apps**. The agent does **not** ask you for any token.
229+
If the agent reports it cannot access a repository in a cloud session, it usually means the account has not authorized the relevant App (GitHub or GitLab), or the target repository / group was not granted — just authorize and grant it under **Customize → Plugins → Apps**. The agent does **not** ask you for any token.
230230
</Note>
231231

232232
## Permissions & Scope

‎en/ai-sre/context.mdx‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Learn about Context
3-
description: Context is the long-lived material AI SRE carries into troubleshooting. People maintain the knowledge base. The system organizes memory. The Context page shows both, by scope.
3+
description: Context is the long-lived material AI SRE carries into troubleshooting. People maintain knowledge. The system organizes memory. The console gives each its own page under Customize → Context.
44
keywords: ["AI SRE", "context", "knowledge", "memory", "DUTY.md"]
55
sidebarTitle: Learn about Context
66
---
@@ -13,34 +13,36 @@ sidebarTitle: Learn about Context
1313

1414
---
1515

16-
Context is the material AI SRE can reuse across troubleshooting sessions. It has two parts, shown together on the **Context** page.
16+
Context is the material AI SRE can reuse across troubleshooting sessions. It has two parts, each with its own page under the **Context** group of the **AI SRE → Customize** sidebar.
1717

18-
- **Memory** is organized by the system. After a session, it keeps preferences, procedures, facts, and lessons that will still matter later. You can also ask, in the conversation, to remember or forget something.
19-
- The **knowledge base** is maintained by people. It describes how this environment runs: a guide named `DUTY.md`, plus runbooks, service lists, and similar files. A session reads the guide first and opens the other files when it needs them.
18+
- **[Knowledge](/en/ai-sre/knowledge)** is maintained by people. It describes how this environment runs: a guide named `DUTY.md`, plus runbooks, service lists, and similar files. A session reads the guide first and opens the other files when it needs them. Entry: **AI SRE → Customize → Context → Knowledge**.
19+
- **[Memory](/en/ai-sre/memory)** is organized by the system. After a session, it keeps preferences, procedures, facts, and lessons that will still matter later. You can also ask, in the conversation, to remember or forget something. Entry: **AI SRE → Customize → Context → Memory**.
20+
21+
Both pages have an input box at the bottom: write what to change, and the console opens a new chat where the AI first explains the change and saves it after you agree.
2022

2123
## Three scopes
2224

2325
---
2426

25-
You pick a scope first. That scope is what you can see here, and what the assistant is allowed to change.
27+
Both kinds of material are organized by scope, but they support different scopes.
2628

27-
| Scope | Memory | Knowledge base |
29+
| Scope | Memory | Knowledge |
2830
| --- | --- | --- |
2931
| Personal | Yours | None |
30-
| Team | That team's | The pack that team already has |
32+
| Team | That team's | That team's (at most one per team) |
3133
| Shared | None | The whole account's |
3234

33-
Personal scope has no knowledge base. Shared scope has no memory.
35+
Personal scope has no knowledge. Shared scope has no memory.
3436

3537
## Read next
3638

3739
---
3840

3941
<CardGroup cols={2}>
40-
<Card title="Learn about the knowledge base" icon="book" href="/en/ai-sre/knowledge">
42+
<Card title="Learn about Knowledge" icon="book" href="/en/ai-sre/knowledge">
4143
How the guide, runbooks, and files are organized, and how the assistant reads them in a session.
4244
</Card>
43-
<Card title="Learn about memory" icon="brain" href="/en/ai-sre/memory">
45+
<Card title="Learn about Memory" icon="brain" href="/en/ai-sre/memory">
4446
How memory is gathered from conversations, what personal and team scopes each show, and how to edit or delete a file on the page.
4547
</Card>
4648
</CardGroup>

0 commit comments

Comments
 (0)