Skip to content

Commit 9476088

Browse files
authored
Merge pull request #1038 from flashcatcloud/docs/style-pass
docs: 按阮一峰中文规范与 Google 英文指南修订全站文风
2 parents 61a58bd + 95a01c0 commit 9476088

702 files changed

Lines changed: 6638 additions & 6676 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.

‎en/ai-sre.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ sidebarTitle: AI SRE
1111

1212
## What is AI SRE?
1313

14-
Flashduty AI SRE is a conversational, autonomous SRE Agent platform. You issue instructions in natural language, and it plans the steps on its own, queries metrics and logs, runs commands, calls external tools (MCP), delegates subtasks when needed, and ends with a conclusion backed by its investigation.
14+
Flashduty AI SRE is a conversational, autonomous SRE Agent platform. You give instructions in natural language. It plans the steps, queries metrics and logs, runs commands, calls external tools (MCP), and delegates subtasks when needed. It ends with a conclusion backed by its investigation.
1515

16-
It is not a question-and-answer chatbot but a **hands-on troubleshooter**, integrated deeply with Flashduty incident response: when an incident triggers or a war room opens, you can spin up a session in one click so the Agent enters the investigation with full incident context — chat in the console, or just **@-mention it in your IM group** (Slack / Feishu / DingTalk / WeCom).
16+
It's a **hands-on troubleshooter** built into Flashduty incident response. When an incident triggers or a war room opens, start a session in one click, and the Agent investigates with full incident context. Chat with it in the console, or **@-mention it in your IM group** (Slack / Feishu / DingTalk / WeCom).
1717

18-
## Core Capabilities
18+
## Core capabilities
1919

2020
<CardGroup cols={2}>
2121
<Card title="Chat to troubleshoot" icon="comments">
@@ -32,7 +32,7 @@ It is not a question-and-answer chatbot but a **hands-on troubleshooter**, integ
3232
</Card>
3333
</CardGroup>
3434

35-
## Typical Scenarios
35+
## Typical scenarios
3636

3737
<CardGroup cols={2}>
3838
<Card title="Conversational troubleshooting" icon="comments">
@@ -53,7 +53,7 @@ It is not a question-and-answer chatbot but a **hands-on troubleshooter**, integ
5353

5454
AI SRE must be activated in the console and is billed on actual usage in credits. Production changes, restarts, rollbacks, and external notifications all require your confirmation before they execute. For activation, billing rules, and subscription requirements, see [Activation and billing](/en/ai-sre/overview#activation-and-billing).
5555

56-
## Get Started
56+
## Get started
5757

5858
<CardGroup cols={2}>
5959
<Card title="Product overview" icon="rocket" href="/en/ai-sre/overview">

‎en/ai-sre/agents.mdx‎

Lines changed: 35 additions & 35 deletions
Large diffs are not rendered by default.

‎en/ai-sre/apps.mdx‎

Lines changed: 38 additions & 38 deletions
Large diffs are not rendered by default.

‎en/ai-sre/artifacts.mdx‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ sidebarTitle: Artifacts
1111

1212
An artifact is a file AI SRE produces in a session with the `present_files` tool and then publishes to the artifact gallery. There are two publish paths, and they accept different types:
1313

14-
- **The agent's `publish_artifact` tool**: publishes HTML / Markdown documents only (`.html` `.htm` `.md` `.markdown`) — a self-contained report or page, most typically the operational insight report generated by typing `/insight` in a session. Every other type is rejected with `unsupported_format`.
14+
- **The agent's `publish_artifact` tool**: publishes HTML / Markdown documents only (`.html` `.htm` `.md` `.markdown`). Each one is a self-contained report or page. The most common example is the operational insight report that `/insight` generates in a session. Every other type is rejected with `unsupported_format`.
1515
- **The "Publish to artifact gallery" button next to a `present_files` file in the console** (see [Creating an artifact](#creating-an-artifact) below): publishes the wider set of types:
1616

1717
<Accordion title="View publishable file types">
@@ -29,23 +29,23 @@ An artifact is a file AI SRE produces in a session with the `present_files` tool
2929

3030
Files outside the table above don't show a "Publish to artifact gallery" button in the session.
3131

32-
A published artifact initially inherits its source session's scope: artifacts from a personal session belong to their creator ("Personal"); artifacts from a session bound to a team belong to that team and can be shared with other account members. Users with edit permission can change the scope later.
32+
A published artifact initially inherits its source session's scope: artifacts from a personal session belong to their creator ("Personal"). Artifacts from a session bound to a team belong to that team and can be shared with other account members. Users with edit permission can change the scope later.
3333

3434
Entry point: **AI SRE → Artifacts** in the left navigation.
3535

3636
<Note>
37-
You can't upload files to the artifact gallery directly: every artifact is produced and published by the agent in a session, and **New artifact** also takes you to a session to do this. The gallery is for browsing, searching, and managing published artifacts.
37+
You can't upload files to the artifact gallery directly. The agent produces and publishes every artifact in a session, and **New artifact** also opens a session for this. The gallery is for browsing, searching, and managing published artifacts.
3838
</Note>
3939

40-
## List Page
40+
## List page
4141

4242
- **Search and filter**: search by title; filter by scope (**All / Personal / Team**). Choosing "Team" lets you pick specific teams; picking none means all teams visible to you.
43-
- **Views**: switch between card view (default) and list view at the top right; your choice is saved in the browser. List view shows the name, scope (team name, or the creator for personal artifacts), source conversation (click to jump; "Conversation deleted" if it no longer exists), created and updated times, a pin button, and actions.
43+
- **Views**: switch between card view (default) and list view at the top right; your choice is saved in the browser. List view shows the name, scope (team name, or the creator for personal artifacts), source conversation (click to jump. "Conversation deleted" if it no longer exists), created and updated times, a pin button, and actions.
4444
- **Sorting**: sort by created or updated time; the default is **updated time, newest first**. Whatever the sort, the artifacts you pinned always come first (most recently pinned first).
4545
- **Paging**: 12 / 24 / 48 per page, 24 by default.
46-
- **Shareable URL**: scope, search term, sorting, and page are kept in the page URL, so copying it shares or bookmarks the filtered list, and returning from a detail page lands you where you were.
46+
- **Shareable URL**: the page URL keeps the scope, search term, sorting, and page. Copy it to share or bookmark the filtered list. When you return from a detail page, you land where you were.
4747

48-
Cards show a content thumbnail (a static preview for HTML, Markdown, images, and plain text; an empty frame for PDFs and other types), a type icon, the title, the edited time (hover for the exact time), the scope, and whether a public link is on and whether it is pinned.
48+
Each card shows a content thumbnail, a type icon, the title, the edited time, and the scope. It also shows whether a public link is on and whether the artifact is pinned. The thumbnail is a static preview for HTML, Markdown, images, and plain text, and an empty frame for PDFs and other types. Hover over the edited time to see the exact time.
4949

5050
### Pinning
5151

@@ -61,7 +61,7 @@ Click **New artifact** at the top right to open a chat with a prefilled draft pr
6161
If a session has already produced the file, click "Publish to artifact gallery" next to it instead — it's faster than starting a new conversation.
6262
</Tip>
6363

64-
## Card Actions
64+
## Card actions
6565

6666
The "More actions" menu on each card offers:
6767

@@ -74,7 +74,7 @@ The "More actions" menu on each card offers:
7474
| Change scope | Requires edit permission; choose Personal or an accessible team. Only the creator can change it back to Personal |
7575
| Delete | Requires edit permission and confirmation. Removes the artifact from the gallery only; the source session and the file itself are kept |
7676

77-
## Detail Page
77+
## Detail page
7878

7979
The top of the detail page offers:
8080

@@ -161,7 +161,7 @@ Any one of the following lets you rename, change the scope of, or delete an arti
161161

162162
Without edit permission you can only pin, copy the link, and download.
163163

164-
## Related Pages
164+
## Related pages
165165

166166
<CardGroup cols={2}>
167167
<Card title="Console Chat" icon="comments" href="/en/ai-sre/sessions">

0 commit comments

Comments
 (0)