贡献
编写文档
在与功能相同的拉取请求中添加并审查 Fumadocs 页面。
公开文档位于 apps/docs/content/docs。内部设计说明和实现计划可以保留在仓库顶层的 docs 文件夹中。
添加页面
创建一个包含标题和描述的 .mdx 文件:
---
title: 功能名称
description: 用一句话说明读者将学到什么。
---
先解释用户成果。将页面文件名添加到最近的 meta.json 中,使其出现在导航中。
本地预览
在仓库根目录下运行:
pnpm docs:dev打开 http://localhost:3000。提交前运行:
pnpm docs:build文档标准
- 描述已发布的行为,不要将尚未合并的 PR 当作已发布内容来写。
- 以用户成果为先,并针对已知故障模式提供确切的恢复步骤。
- 明确说明平台和安全边界。
- 优先链接到稳定的公开文档,而不是重复冗长的内部设计记录。
- 不要将未发布的声明写入变更日志。只有在发布发布后,才会从 GitHub 读取条目。