跳转到主要内容

​
贡献文档

这个仓库同时包含当前的 OpenClaw 文档、保留中的 Trellis legacy 工作流文档，以及整理型学习资料。优先在原地优化，不要随意删除旧内容，除非任务本身就是清理或迁移。

​
仓库内容分层

内容线状态编辑时怎么处理
openclaw/ 与 zh/openclaw/当前维护中的主线优先保证阅读路径清楚；如果另一种语言已有对应页，尽量同步更新
guide/、zh/guide/、guides/、zh/guides/保留中的 Trellis legacy 文档保留现有路由和历史上下文，优先补说明，不要粗暴删改
ml/ 与其他归档导入内容维护中的入口页 + 仓库保留的原始资料优先整理入口页；raw 文件只有在清洗后才重新纳入导航

​
本地工作流

  1. Fork 并克隆仓库。
git clone https://github.com/YOUR_USERNAME/GeneTind-docs.git
cd GeneTind-docs
  1. 如果你本机还没有 Mintlify CLI，先安装。
npm install -g mint
  1. 启动本地预览。
mint dev
  1. 提交 PR 前至少做一轮校验。
mint broken-links
mint validate

​
哪些文件经常需要一起改

  • 内容页：openclaw/、zh/openclaw/、guide/、zh/guide/、guides/、zh/guides/
  • 导航和站点配置：docs.json
  • 图片和静态资源：public/、images/、logo/
  • 中英双语成对页面，尤其是 openclaw/ 与 zh/openclaw/

​
贡献规则

  • 同一章节、同一教程链路里的页面和图片，优先用相对路径。
  • 跨大区块跳转时，再用根相对路径。
  • 不要直接链接 .md 或 .mdx 文件。
  • 新页面如果不写进 docs.json，就不会出现在导航里。
  • 能优化现有页面时，优先不要新建并行页面。
  • 示例里不要出现密钥、私有 token 或内部接口。
  • 如果修改了用户可见的 OpenClaw 页面，且另一种语言存在对应页面，尽量同步更新。
  • 如果你在改 legacy Trellis 页面，优先补充说明和修正文案，不要直接抹掉历史路由。
  • 如果你在改归档资料，先补一个维护中的 MDX 入口页，再决定是否把更多原始文件挂进导航。

​
推荐自检清单

  1. frontmatter 至少有 title 和 description
  2. 新增或移动的页面已经更新 docs.json
  3. 内链和图片路径符合上面的“同区块相对路径 / 跨区块根相对路径”规则
  4. mint broken-links 通过
  5. mint validate 通过
  6. 文风和周边页面保持一致

​
值得优先贡献的内容

  • 失效链接和导航漂移
  • 过时的安装说明
  • 入口页太薄、读者不知道该从哪看起的页面
  • openclaw/ 与 zh/openclaw/ 的双语一致性
  • frontmatter、描述和页面组织的可发现性问题

​
Issue 与 PR

发现文档有问题？开一个 issue： https://github.com/lilinji/GeneTind-docs/issues 包含：
  • 哪个页面有问题
  • 哪里有错或者不清楚
  • 建议的修复方案
提交 PR 时，写清楚你改了哪些页面、为什么要改，以及如果你本地没法跑 Mintlify 校验，卡在哪里。