SuperAPI AI 工具集

contribute

写作与研究

查看项目

更新于 10-16 01:16

技能介绍

用途:这是 Trellis 的贡献指南,面向希望为其文档站与资源市场(marketplace)提交内容的贡献者,覆盖规范模板、技能、文档页面、博客、展示项目与 PR 流程。

仓库划分:文档页面位于 mindfold-ai/docs(Mintlify 文档站);技能与规范模板位于 mindfold-ai/Trellis 的 marketplace/ 目录。

主要能力与流程:

  1. 规范模板:在 marketplace/specs/ 下创建模板目录(含 README.md,以及 frontend/、backend/、guides/、shared/ 等按技术栈取舍),在 marketplace/index.json 注册(含 id、type、name、description、path、tags),并在 docs 仓库创建中英双语文档页 templates/specs-.mdx 与 zh/templates/specs-.mdx,更新 docs.json 导航与概览页。
  2. 技能:在 marketplace/skills/ 下创建目录(SKILL.md 必需,references/ 可选),同样在 index.json 注册,并创建 skills-market/.mdx 与 zh/skills-market/.mdx 文档页、更新导航与概览。用户安装命令为:npx skills add mindfold-ai/Trellis/marketplace -s your-skill。
  3. 展示项目:复制 showcase/template.mdx 与 zh/showcase/template.mdx,填写项目信息,更新 docs.json 的 Showcase 分组,并在概览页添加 Card 组件。
  4. 文档与博客:在 guides/、blog/ 等目录创建页面并同步中文版本,更新 docs.json 对应分组。

导航配置:docs.json 按语言(en、zh)组织,英文页面无前缀,中文页面加 zh/ 前缀,支持嵌套分组,expanded: false 默认折叠。

双语要求:所有面向用户的内容必须同时提供英文与中文版本,路径成对(如 guides/.mdx 与 zh/guides/.mdx)。

开发与校验:使用 pnpm install 安装依赖,pnpm dev 启动本地预览,pnpm lint:md 检查 Markdown,pnpm verify 校验文档结构,pnpm format 格式化;项目使用 husky 与 lint-staged,提交时自动 lint、格式化并运行 verify-docs.py 检查 docs.json 与 frontmatter。

PR 流程:文档改动 fork mindfold-ai/docs,技能/模板改动 fork mindfold-ai/Trellis,克隆后建分支、按指南修改、本地测试、使用约定式提交信息并推送创建 PR。提交前需确认双语版本、docs.json 与 index.json 更新、概览页条目、本地预览、无失效链接、代码块语言标签与 frontmatter 完整。

限制:资料未提供具体收费、价格或平台支持范围等信息。