Skip to content

docs: 文档质量升级 P1-P3 — README/CONTRIBUTING/架构文档#65

Merged
bigmanBass666 merged 1 commit into
mainfrom
doc-quality
Jul 17, 2026
Merged

docs: 文档质量升级 P1-P3 — README/CONTRIBUTING/架构文档#65
bigmanBass666 merged 1 commit into
mainfrom
doc-quality

Conversation

@bigmanBass666

Copy link
Copy Markdown
Contributor

变更内容

P1: README 质感提升

  • 动态 badges(Go 版本、GitHub Actions 测试、Release)
  • 安装方式改为 go install ./cmd/akswitch/
  • 新增 compact 日志格式的终端输出示例
  • feature 列表 emoji 排版 + 新增 RPM 感知、Token 追踪、compact 日志条目
  • 修复"单进程多实例"→"单端口多 provider"、".env"→"TOML 配置"
  • 文档表格新增 CHANGELOG 链接

P2: CONTRIBUTING.md 开发指南

  • 构建说明、测试分层(unit/integration/e2e)
  • PR 流程、分支策略、提交规范
  • 文档纪律(改功能需同步改文档)

P3: 架构文档补全

  • ProviderRouter 架构 + 请求路由流程图
  • 管理 API 路由表
  • 完整请求生命周期(10 步)
  • RPM 感知 Key 选择算法
  • Token 用量追踪 + Calibrator 校准

Closes #62

@bigmanBass666
bigmanBass666 marked this pull request as ready for review July 17, 2026 17:17
@bigmanBass666
bigmanBass666 enabled auto-merge (squash) July 17, 2026 17:18
@bigmanBass666
bigmanBass666 merged commit b607ab3 into main Jul 17, 2026
4 checks passed
@bigmanBass666
bigmanBass666 deleted the doc-quality branch July 17, 2026 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

文档质量升级计划 — 拉到 95 分

1 participant