Skip to content

Commit 2d70c76

Browse files
authored
docs: add external workflow integration guide (#1596)
* docs: add external workflow integration guide Signed-off-by: FenjuFu <fufenjupku@gmail.com> * docs: resolve README conflict with main Signed-off-by: FenjuFu <92919259+FenjuFu@users.noreply.github.com> --------- Signed-off-by: FenjuFu <fufenjupku@gmail.com> Signed-off-by: FenjuFu <92919259+FenjuFu@users.noreply.github.com>
1 parent 9e6d3f5 commit 2d70c76

7 files changed

Lines changed: 837 additions & 177 deletions

File tree

README.md

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

docs/.vitepress/config.mts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ export default defineConfig({
2626
nav: [
2727
{ text: "Home", link: "/" },
2828
{ text: "Quick Start", link: "/guide/quick-start" },
29+
{ text: "Integration", link: "/guide/integration" },
2930
{ text: "Deployment", link: "/guide/deploy" },
3031
{ text: "Case Studies", link: "/cases/" },
3132
{ text: "Examples", link: "/examples" },
@@ -38,6 +39,7 @@ export default defineConfig({
3839
items: [
3940
{ text: "Project Overview", link: "/README" },
4041
{ text: "Quick Start", link: "/guide/quick-start" },
42+
{ text: "Integrate Into Your App", link: "/guide/integration" },
4143
{ text: "FAQ", link: "/faq" }
4244
]
4345
},
@@ -113,6 +115,7 @@ export default defineConfig({
113115
nav: [
114116
{ text: "首页", link: "/zh/" },
115117
{ text: "快速开始", link: "/zh/guide/quick-start" },
118+
{ text: "集成指南", link: "/zh/guide/integration" },
116119
{ text: "部署与配置", link: "/zh/guide/deploy" },
117120
{ text: "案例实践", link: "/zh/cases/" },
118121
{ text: "工作流示例", link: "/zh/examples" },
@@ -125,6 +128,7 @@ export default defineConfig({
125128
items: [
126129
{ text: "项目概览", link: "/zh/README" },
127130
{ text: "快速开始", link: "/zh/guide/quick-start" },
131+
{ text: "集成到现有项目", link: "/zh/guide/integration" },
128132
{ text: "FAQ", link: "/zh/faq" }
129133
]
130134
},

docs/.vitepress/theme/AstronHomePage.vue

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ const { lang } = useData();
1616
const zhContent = {
1717
nav: {
1818
quickStart: "快速开始",
19+
integration: "集成指南",
1920
deploy: "部署指南",
2021
cases: "案例实践",
2122
config: "配置说明",
@@ -106,6 +107,11 @@ const zhContent = {
106107
resourcesTitle: "文档、社区与部署入口",
107108
resourcesText: "从首页进入稳定的信息架构,把说明文档和社区入口统一收敛到 Pages 文档站。",
108109
resourceCards: [
110+
{
111+
title: "集成到现有项目",
112+
description: "通过公开 HTTP/SSE API 调用已发布工作流,了解鉴权、请求参数、流式响应与生产边界。",
113+
href: "/guide/integration"
114+
},
109115
{
110116
title: "快速开始",
111117
description: "两步完成本地体验,先拉起 Docker Compose 环境再进入控制台。",
@@ -151,6 +157,7 @@ const zhContent = {
151157
const enContent = {
152158
nav: {
153159
quickStart: "Quick Start",
160+
integration: "Integration",
154161
deploy: "Deployment",
155162
cases: "Case Studies",
156163
config: "Configuration",
@@ -244,6 +251,11 @@ const enContent = {
244251
resourcesText:
245252
"Move from the landing page into a stable information architecture that keeps documentation and community entry points in one place.",
246253
resourceCards: [
254+
{
255+
title: "Integrate Into Your App",
256+
description: "Call published workflows through the public HTTP/SSE API, with authentication, payload, streaming, and production guidance.",
257+
href: "/guide/integration"
258+
},
247259
{
248260
title: "Quick Start",
249261
description: "Get a local experience running in two steps before diving deeper into the platform.",
@@ -329,6 +341,7 @@ onBeforeUnmount(() => {
329341
</a>
330342
<div class="astron-home__nav-links">
331343
<a :href="localizePath('/guide/quick-start')">{{ content.nav.quickStart }}</a>
344+
<a :href="localizePath('/guide/integration')">{{ content.nav.integration }}</a>
332345
<a :href="localizePath('/guide/deploy')">{{ content.nav.deploy }}</a>
333346
<a :href="localizePath('/cases/')">{{ content.nav.cases }}</a>
334347
<a :href="localizePath('/guide/config')">{{ content.nav.config }}</a>
@@ -349,7 +362,7 @@ onBeforeUnmount(() => {
349362
{{ content.heroText }}
350363
</p>
351364
<div class="astron-home__actions">
352-
<a class="astron-home__button astron-home__button--primary" href="https://github.com/iflytek/astron-agent" target="_blank" rel="noreferrer">{{ content.primaryAction }}</a>
365+
<a class="astron-home__button astron-home__button--primary" :href="localizePath('/guide/integration')">{{ content.nav.integration }}</a>
353366
<a class="astron-home__button astron-home__button--secondary" href="https://agent.xfyun.cn" target="_blank" rel="noreferrer">{{ content.secondaryAction }}</a>
354367
</div>
355368
<ul class="astron-home__metrics">

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ After startup, you can access the services at the following addresses:
104104

105105
## 📚 Documentation
106106

107+
- [🔌 Integration Guide](/guide/integration) — call published workflows from an existing project via HTTP/SSE
107108
- [🚀 Deployment Guide](/DEPLOYMENT_GUIDE)
108109
- [🔧 Configuration](/CONFIGURATION)
109110
- [🏢 Case Studies](/cases/)

0 commit comments

Comments
 (0)