用途:规范 uploads.sh 文档站页面(apps/web/src/content/docs/ 下的 MDX 主题页与 apps/web/src/pages/docs.astro 枢纽页)的写法,目标是让页面读起来像 Stripe、Vercel、Wrangler 等成熟开发者文档。
主要能力与结构要求:每个主题页只讲一件事,按“理解→配置→执行”排序,先一句定位再给可直接运行的命令;采用单一主路径,其他做法降级为一行指针;枢纽页只做分流与链接,不重复教学。
写法约定:引言一句加能力列表,避免铺垫;一段一个观点;不编造终端输出;排障与边界情况放末尾、note 或链接页;行内 code 只用于短标识符和单个 token,完整多参数命令放代码块。
代码块约定:bash 为可复制命令(提示符由 CSS 绘制,行尾 # 注释复制时会被去除);ansi 输出不可复制、可带 title;text 用于可复制的非 shell 行;yaml/json 配置示例带语法高亮;命令与配置约 80 字符不换行。复制入口每个操作一个,参考命令清单用一个 ansi 块即可。真正等价的替代项用 Tabs/TabItem 且可共享 syncKey。
组件词表:lead、section、h2 锚点、note、pointer、callout、cards/card、table、GhComment、GithubAppInstalledBanner 等由 DocsLayout 提供,复用而不是新增类;前后翻页由 navOrder 自动生成。
使用方式:新增主题页即在 docs 内容集合新建 .mdx 文件,文件名即 URL slug,导航、prev/next 与静态路径由 frontmatter 派生;需保持 MDX 合法(如 section 内留空行、用 div.note 而非 p.note、行首避免内联组件),并在 apps/web 下运行 pnpm build 验证。
限制:不得虚构命令、参数、URL 或能力;仅在确有必要时新增样式类;页面特定且不可泛化的标记应抽成 apps/web/src/components/docs/ 下的小型 .astro 组件。其他事实暂未提供。