PureChatNext 文档
PureChatNext 的快速开始、开发指南与自托管文档入口。
需要访问旧版 PureChat 文档? 打开旧版文档
这里收录 PureChatNext 的公开中文文档。请按读者任务进入对应分类:
正式文档站:https://next-docs.purechat.cn。旧版 VitePress 文档仍位于 https://docs.purechat.cn。本目录仍是 GitHub 阅读与新版文档站构建共用的唯一内容源。
文档维护规则
docs/根目录除本索引外不新增文档;公开文档只放在getting-started/、development/和self-hosting/。- 按读者任务和稳定领域分类,不按临时项目、负责人或时间阶段分类。
- 同一目录直属文档达到 9 个时,应按子领域继续拆分;目录深度通常不超过 3 层。
- 文件名使用 kebab-case;当前只维护中文,不添加 locale 后缀。
- 每篇公开 Markdown 必须在文件开头声明
title与descriptionfrontmatter,正文继续保留一个一级标题。 - 每个公开内容目录使用
meta.json固定站点导航顺序;新增、移动文档时同步维护最近一级配置。 - 新文档必须从本索引或所属分类的
README.md可达,并使用相对链接引用其他仓库文件。 - 移动或重命名文档时,全仓更新 Markdown、源码注释、脚本提示和产品页面中的旧路径。
docs/private/存放本地内部资料,已被 Git 忽略,不属于公开文档,也不得进入公开文档站构建输入。- 提交前运行
pnpm lint:docs、pnpm lint:md和pnpm build:docs。
新增文档检查清单
- 确认目标读者和所属分类。
- 添加
title、descriptionfrontmatter,并使用一个清晰的一级标题说明主题。 - 将文档加入最近一级分类索引和
meta.json导航。 - 检查相对链接和示例命令。
- 运行内容检查和文档站构建。