SuperAPI AI 工具集

contribute

写作与研究

查看项目

更新于 10-16 09:46

技能介绍

用途:本技能为 Trellis 文档项目提供贡献流程指引,适用于新增规范(spec)模板、向技能市场添加新技能、新增或更新文档页面、以及提交展示项目等场景。

主要能力:介绍项目目录结构(docs/、guides/、templates/、skills-market/、blog、changelog、contribute、showcase、plugins/、marketplace/),说明 docs.json 的按语言导航结构(英文页无前缀,中文页使用 zh/ 前缀,支持嵌套分组与 expanded:false 折叠);给出新增 spec 模板、技能插件、展示项目与普通文档的步骤,包括创建目录与页面、填写 frontmatter、注册 marketplace.json、更新总览页和导航;并列出双语要求(所有面向用户内容需同时提供英文与中文版本)。

使用方式:本地开发需执行 pnpm install 安装依赖,pnpm dev 启动本地预览,pnpm lint:md 检查 Markdown,pnpm verify 校验文档结构,pnpm format 格式化文件;项目使用 husky 与 lint-staged,提交时自动对 Markdown 进行 lint 与格式化,并由 verify-docs.py 检查 docs.json 与 frontmatter。提交 PR 需先 Fork 仓库 https://github.com/mindfold-ai/docs,再 git clone 自己的 Fork,创建分支(如 git checkout -b feat/your-contribution),本地测试后以约定式提交信息提交并推送,最后向原仓库 main 分支发起 PR。

限制与注意:PR 前需确认中英文版本齐备、docs.json 两种语言均已更新、总览页已加入新条目、本地预览通过、无失效链接、代码块语言标签正确、frontmatter 包含 title 与 description,图片放入 images/ 目录;marketplace/ 中的内容不参与 Mintlify 渲染。具体组件与更多细节以项目文档为准,资料未提供的部分暂未提供。