mirror of
https://github.com/labring/FastGPT.git
synced 2026-04-18 02:06:33 +08:00
f057a2ae19
* docs(faq): 更新常见问题文档并新增注意事项页面 - 在 error.mdx 中调整问题序号并新增 OCR 配置问题 - 新增 attention.mdx 页面，提供问题排查步骤和技术支持指引 - 重构 dataset.mdx 内容结构，使用数字序号并补充知识库闪烁问题 * docs: 重构私有部署故障排查文档结构并新增详细指南 将原有的 FAQ 文档拆分为多个专题文档，包括通用问题排查、S3问题、OneAPI错误、模型可用性问题和排查方法。更新了导航菜单和目录结构，使文档组织更清晰，便于用户快速定位和解决特定问题。 新增了详细的故障排查步骤、CURL测试示例和具体错误解决方案，特别是针对对象存储连接、签名错误和模型调用失败等常见问题提供了更全面的指导。 * docs: 移除已弃用的 OneAPI 错误排查文档 移除 `oneapi-errors` 相关文档文件，因其内容已过时或合并至其他章节。同步更新中英文文档目录和元数据文件中的引用。 * docs: 更新文档FAQ内容，移除过时条目并重新编号 - 删除关于OneAPI官网的过时FAQ条目 - 重新编号故障排除FAQ章节，使序号连续 - 同步更新中英文文档内容保持一致 --------- Co-authored-by: Archer <545436317@qq.com>
FastGPT 文档
这是FastGPT的官方文档，采用 fumadoc 框架。
运行项目
要运行文档，首先需要进行环境变量配置，在文档的根目录下创建.env.local文件，填写以下环境变量:
FASTGPT_HOME_DOMAIN = #要跳转的FastGPT项目的域名，默认海外版
你可以在FastGPT项目根目录下执行以下命令来运行文档。
npm install # 只能 npm install，不能 pnpm
npm run dev
项目会默认跑在http:localhost:3000端口
书写文档
文档采用mdx格式，大体和md一致，但是现在文档的元数据只支持title description和icon三个字段，参考以下示例代码：
---
title: FastGPT 文档
description: FastGPT 官方文档
icon: menu #icon采用`lucide-react`第三方库。
---
import { Alert } from '@/components/docs/Alert'; #高亮块组件
<Alert icon="🤖" context="success">
快速开始体验
- 海外版：[https://fastgpt.io](https://fastgpt.io)
- 中国大陆：[https://fastgpt.cn](https://fastgpt.cn)
</Alert>
import {Redirect} from '@/components/docs/Redirect' #重定向组件，如果你希望用户点击这个文件跳转到别的文件的话，详情参考 `FAQ`的`Docker 部署问题`文档。
<Redirect to="/docs/self-host/deploy/docker/#faq" />
<Tabs items={['Javascript', 'Rust']}> #tabs组件用法，渲染效果参考`introduction`下`development`的`faq`文档
<Tab value="Javascript">Javascript is weird</Tab>
<Tab value="Rust">Rust is fast</Tab>
import FastGPTLink from '@/components/docs/linkFastGPT'; #FastGPT跳转链接组件，通过接收一个域名环境变量，来实现跳转到海外或者国内
本文档介绍了如何设置开发环境以构建和测试 <FastGPTLink>FastGPT</FastGPTLink>。
</Tabs>
在书写完文档后，需要在对应的目录下的meta.json文件的pages字段合适位置添加自己的文件名。例如在content/docs(默认这是所有文档的根目录)的introduction目录下书写了一个hello.mdx文件。则需要去introduction目录下的meta.json添加以下内容:
{
"title": "FastGPT Docs",
"root": true,
"pages": ["[Handshake][联系我们](https://fael3z0zfze.feishu.cn/share/base/form/shrcnjJWtKqjOI9NbQTzhNyzljc)","index","guide","development","FAQ","shopping_cart","community","hello"], #"hello"原本没有，此外，这里的顺序就是最后文档的展示顺序，现在"hello"文档将会在`introduction`的最后展示
"order": 1
}
i18n
在content/docs下的所有.mdx文件为默认语言文件(当前默认语言中文)，.en.mdx文件为i18n支持的英文文件，例如，你可以将hello.mdx文档翻译后，写一个hello.en.mdx,同时，在对应目录的meta.en.json的"pages"字段写下对应的文件名来支持英文文档。
特殊配置
增加顶层导航栏
- 在
FastGPT/document/app/[lang]/docs/layout.tsx文件中新增导航。
重定向
在FastGPT/document/components/docs/not-found.tsx文件中新增重定向规则。