Docs: Fix stale claims in CLAUDE.md and remove duplicated text

未关闭
#1,663 0 条评论 0 个 reaction 已指派 1 人 在 GitHub 查看

维护者通常 1 天内回复

@huang195 已经在做这个了。

开始于 2026年11月5日。

  • #1664 来自 @huang195 —— 未关闭

评估

这个 Issue 还没有评估数据。

描述

CLAUDE.md is 130 KB, about 49k tokens. Claude Code sends it on every request in this repo, and it is in every cache rebuild. On the maintainer's own traffic it is about 13% of Opus spend.

An audit against main (af397ebb) found three problems:

  1. About 25 claims are no longer true. Examples:
    • go vet "gates only 7 of 11 modules". All 11 are vetted.
    • The podman build examples fail without GO_BUILD_TAGS.
    • ROUTES_CONFIG_PATH is not read by any code.
    • Route hosts use filepath.Match. They use gobwas/glob.
    • The Catalog pane opens with P. It opens with C.
    • The hot-reload exclusion list is incomplete.
  2. About 35 KB repeats docs/. The session API section repeats docs/session-api.md. The mTLS sections repeat docs/framework-architecture.md §8a.
  3. About 10 KB is history only: past measurements and bug narratives that give an agent no rule.

Fix: correct the false claims. Move the session API details that only CLAUDE.md has into docs/session-api.md. Then remove the duplicates and the history. Target: about 37% smaller, with no facts lost.

主要语言
Go
星标
23
派生
44
平均合并
16 小时 32 分钟
30 天内合并 PR
227

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

rossoctl/cortex 的其他 Issue

查看 rossoctl/cortex 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。