Skip to content

Commit 136e8eb

Browse files
committed
update start.md
1 parent 137e6d3 commit 136e8eb

1 file changed

Lines changed: 19 additions & 21 deletions

File tree

start.md

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,18 @@
2828

2929
当需要新增一个发布项目或将现有项目标记为已发布状态时,需要进行以下操作:
3030

31-
### 1. 更新项目配置文件
31+
### 1. 创建项目文档
32+
33+
1. 补充中英文README.md, 同步到 `/docs/intro.md` 以及多语言目录下的 `/i18n/en/docusaurus-plugin-content-docs/current/intro.md`
34+
2.`/docs/` 目录下创建项目文档目录,例如 `/docs/your-project/`
35+
3. 创建 `intro.md` 作为项目介绍页面,并补充 `/docs/intro.md` 以及多语言目录下的 `/i18n/en/docusaurus-plugin-content-docs/current/intro.md`中对应的项目链接,例如:
36+
```
37+
### [Bella-openapi - 全能AI能力网关](./bella-openapi/intro.md)
38+
```
39+
4. 根据需要添加其他文档页面
40+
5. 多语言支持,在 `/i18n/en/docusaurus-plugin-content-docs/current` 目录下创建项目文档目录,同步新增的文档
41+
42+
### 2. 更新项目配置文件
3243

3344
`config/projects-data.json` 文件中添加或修改项目信息:
3445

@@ -38,15 +49,15 @@
3849
{
3950
"id": "your-project-id",
4051
"name": "项目名称",
41-
"description": "项目详细描述", //复制readme
42-
"en_description": "英文版的详细描述", //复制英文的readme
43-
"type": "gateway", // 项目类型:gateway(网关层)、endpoint(能力层)、infer(推理服务层)、model(模型层)或 application(应用层)
52+
"description": "项目描述", //复制readme.md中对该项目的介绍
53+
"en_description": "英文版的描述", //复制英文的readme中对该项目的介绍
54+
"type": "endpoint", // 项目类型:gateway(网关层)、endpoint(能力层)、infer(推理服务层)、model(模型层)或 application(应用层)
4455
"status": "released", // 将状态设置为 "released" 表示已发布
4556
"github": "https://github.com/YourOrg/your-project",
46-
"apiDocPath": "your-project-api-path", // API 文档路径
47-
"link": "https://your-project-url/", // 项目的线上体验链接
48-
"documentationLink": "/docs/your-project/intro", // 文档链接
49-
"dependencies": [ // 项目依赖关系
57+
"apiDocPath": "your-project-api-path", // OpenAPI Json文件的存放路径,统一存放在 /static/openapi目录下,此处不需要填写目录前缀,例如Openapi Json文件位于 /static/openapi/bella-openapi目录下,此处应填bella-openapi,如不提供API Doc页面则不需要填写
58+
"link": "https://your-project-url/", // 项目的线上体验链接,如不存在则不需要填写
59+
"documentationLink": "/docs/your-project/intro", // 文档链接,统一为 /docs/{your-project}/intro
60+
"dependencies": [ // 与其他项目的依赖关系
5061
{
5162
"project": "dependent-project-id",
5263
"endpoints": ["authoriztion", "AI Endpoint"] // 可以是字符串或字符串数组
@@ -57,19 +68,6 @@
5768
}
5869
```
5970

60-
### 2. 创建项目文档
61-
62-
如果这是一个新项目,需要创建相应的文档文件:
63-
64-
1. 补充中英文README.md, 同步到 `/docs/intro.md` 以及多语言目录下的 `/i18n/en/docusaurus-plugin-content-docs/current/intro.md`
65-
1.`/docs/` 目录下创建项目文档目录,例如 `/docs/your-project/`
66-
2. 创建 `intro.md` 作为项目介绍页面,并补充 `/docs/intro.md` 以及多语言目录下的 `/i18n/en/docusaurus-plugin-content-docs/current/intro.md`中对应的项目链接,例如:
67-
```
68-
### [Bella-openapi - 全能AI能力网关](./bella-openapi/intro.md)
69-
```
70-
3. 根据需要添加其他文档页面
71-
4. 多语言支持,在 `/i18n/en/docusaurus-plugin-content-docs/current` 目录下创建项目文档目录,同步新增的文档
72-
7371
### 3. 更新侧边栏配置
7472

7573
`sidebars.ts` 文件中添加新项目的文档链接,确保用户能够在导航中找到新项目的文档:

0 commit comments

Comments
 (0)