docs: 全面同步过时文档至当前代码状态#197
Merged
Merged
Conversation
补齐双方言数据库(PG/SQLite)、Playwright E2E、计费/cliproxy/流量录制/ 后台同步等服务层、能力路由模型、真实 CI 检查项与默认端口等已偏离的内容。
经多代理逐篇对照源码核查 43 篇活跃文档,修复 33 篇的事实性偏差: - openspec/project.md:整篇重写,此前为 FastAPI+Next.js monorepo 脚手架 模板,与实际单体 Next.js 应用完全不符。 - docs/.vitepress/config.ts:footer 许可证 MIT 更正为 AGPL-3.0。 - docs/circuit-breaker.md:熔断默认值 openDuration 30s→300s、probeInterval 10s→30s;配置示例改为真实的 circuit_breaker_config 顶级字段;JSONB→JSON。 - request-lifecycle.md:删除不存在的 status:in-progress 字段描述,模型匹配 模块由 model-router.ts 更正为 filterCandidatesByModelRules。 - security.md:revealApiKey 路径 auth.ts 更正为 key-manager.ts。 - model-routing.md:alias 精确匹配语义、GET /chat/completions 不支持、补充 streamGenerateContent 路径。 - circuit-breaker-config.md:失败规则端点方法 GET/PATCH 更正为 PUT/DELETE。 - troubleshooting/quickstart:缺 ADMIN_TOKEN 不致启动失败的行为更正。 - env-reference 等:RECORDER_FIXTURES_DIR 代码默认值、CORS_ORIGINS 无运行 期效果等说明补正。 - 架构与使用文档中大量随代码增长漂移的源码行号,按当前代码重新核对更正。 - README/README_EN:TypeScript 徽章版本对齐主版本约束。
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
背景
通过多代理逐篇对照源码,全量核查了仓库 43 篇活跃文档(README、docs 站点、openspec/project.md、PR 模板、VitePress 配置)与当前代码的一致性。诊断结论:3 篇 broken、14 篇 stale、17 篇 minor、9 篇本就准确。本 PR 修复其中 33 篇 + CLAUDE.md。
主要修复
整体错误
行为/语义事实错误
openDuration30s→300s、probeInterval10s→30s;配置示例由错误的config.circuit_breaker包装改为真实的顶级字段circuit_breaker_config;JSONB→JSON。status: in-progress字段;模型匹配模块model-router.ts→filterCandidatesByModelRules。revealApiKey路径auth.ts→key-manager.ts。GET /chat/completions实际被拒、补充streamGenerateContent路径。GET/PATCH→PUT/DELETE。ADMIN_TOKEN不会导致启动失败(返回 401),更正该排障描述。RECORDER_FIXTURES_DIR代码默认值data/traffic-recordings与 docker-compose 默认tests/fixtures的区分;CORS_ORIGINS当前仅解析、无运行期效果。livePulse、迁移文件计数更正。行号同步
架构与使用文档中大量随代码增长漂移的源码行号引用,每篇均由修复代理重新 Read 当前代码核对后更正(而非套用诊断估算值)。
校验
prettier --check。tsc --noEmit)。范围说明
未改动 openspec 归档变更(
changes/archive/**)、进行中的变更提案与 specs 规格库——它们是历史/工作流管理的快照,不属于「与代码同步」的范畴。