D1
英文和中文页面保持成对
每个 en/ 页面都应在 zh/ 下有相同相对路径。结构应保持一致，文案不必逐字翻译。
文档维护
本页定义 ProxAI 文档应如何演进。它面向维护者，并补充 AGENTS.md。
| 分区 | 负责 | 不应负责 |
|---|---|---|
using/ | 运行、配置、路由、观测、排障的任务式说明。 | 源码级实现细节或完整字段查表。 |
protocol/ | 线协议行为、请求路径、协议概念、流式预期和交互示例。 | 内部 Rust 模块归属，除非有助于理解上下文。 |
developer/ | 实现边界、模块地图、转换内部、流式内部和贡献流程。 | 普通用户入门或面向搜索的产品介绍。 |
reference/ | 稳定查表值、默认值、精确字段、行为契约、术语表和表格。 | 逐步教程或推测性未来功能。 |
D2
开发者页面 noindex
developer/ 下页面应包含 robots: noindex，让普通搜索流量优先进入用户文档。
D3
Reference 保持稳定
Reference 页面优先使用精确值、紧凑表格和行为契约，而不是叙事教程。
D4
扫描型内容使用组件
卡片、查表、时间线、模块地图和协议矩阵优先用 MDX 组件，而不是原始 Markdown 表格。
D5
避免旧 slug
不要重新引入旧的根级页面。当前公开文档位于 using/、protocol/、developer/ 和 reference/ 下。
D6
私有数据不进仓库
不要提交 captures、logs、prompts、API keys、Authorization headers 或私有上游 payload。
改行为时检查哪些文档
Section titled “改行为时检查哪些文档”| 变更 | 需要检查的文档 |
|---|---|
| 运行时配置字段 | using/configuration、reference/configuration、reference/defaults-and-limits、config.example.toml、README 文件。 |
| 协议转换行为 | protocol/、developer/protocol-conversion、reference/protocols、reference/status-and-stop-reasons。 |
| 流式行为 | protocol/streaming-behavior、developer/streaming-internals、reference/behavior-contracts。 |
| 错误响应行为 | using/troubleshooting、reference/error-responses、developer/error-handling-internals、行为契约。 |
| 发布/部署文档 | using/install-and-upgrade、site/README.md，站点发布变化时也检查 GitHub Pages workflow。 |
发布文档前运行站点检查：
just site check该命令会构建 Starlight 站点，并检查双语页面成对、sidebar slug、内部链接、锚点、旧路径、Markdown 表格残留、developer noindex、hub 覆盖和标题质量。