starcat-docs

Imported from starcat-app/starcat-docs (AGENTS.md). Install upstream with npx skills add starcat-app/starcat-docs. Copyright stays with the author.

AGENTS.md

本文档是 starcat-docs 的 AI 协作规则唯一维护源。

仓库边界

• 本目录是 Starcat 官方用户文档的独立 Git 仓库，拥有独立分支、remote、提交和发布 边界；不得把改动并入外层 Starcat 主仓库或顺带修改相邻 supports/* 项目。
• 开工前核对本仓库 git status --short 与当前分支，保留用户已有改动；未经明确要求 不 commit、push、切分支或修改 remote。
• 应用行为、版本与权益描述必须以已发布产品事实为准，不把计划功能写成已上线能力。

用途、技术栈与目录

• 本仓库使用 Mintlify 与 MDX 维护 Starcat 安装、Stars 管理、AI、RAG、Release、 集成、自托管和故障排查文档。
• 根目录各主题目录保存英文页面，zh-Hans/ 保存对应简体中文页面；docs.json 是 Mintlify 站点配置、双语导航、主题与公开链接的单一来源。
• images/、logo/ 等静态资源必须使用稳定路径；调整页面路径时同步修正 docs.json、站内链接和另一语言页面。

双语与内容规则

• 新增或修改产品事实、步骤、限制、链接和导航时，必须检查英文页面与 zh-Hans/ 对应页面并保持语义同步；允许自然表达，不做同语种复制或机械直译。
• 页面 frontmatter、组件标签、代码、命令、配置项、URL 和产品专有名保持技术字面量； 面向用户的解释分别使用英文和简体中文。
• 修改导航必须保证两种语言都可达，页面路径与 docs.json 条目严格一致；不得只新增 文件却遗漏导航，或只删导航留下孤立页面。
• 截图、日志和示例不得包含 Token、邮箱、仓库私有信息或其他用户数据。

验证命令

mint validate
mint broken-links
git diff --check

需要视觉验收时可运行 mint dev 并检查两种语言的导航、组件和链接；它会启动本机长驻 服务，任务结束后应停止。

外部副作用禁令

• 本仓库连接 Mintlify 发布链路；push，尤其是推送发布分支，可能直接发布公开文档。 未经 dong4j 明确授权不得 push、触发发布或修改 Mintlify 项目配置。
• 不得擅自登录 Mintlify、创建预览/生产部署、修改域名或遥测设置；本地校验通过不等于 获得发布授权。