Skip to content

Commit c93c479

Browse files
committed
docs: move persistent project library from planned to shipped (EN+CN)
1 parent d3ca512 commit c93c479

2 files changed

Lines changed: 2 additions & 4 deletions

File tree

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ CodeABC/
208208

209209
### Shipped
210210

211-
The reading experience is already complete end to end: a plain-language project manual, hover annotations, a terminology dictionary, natural-language editing, and snippet Q&A, all in a bilingual UI you launch with one command (or as a native Tauri desktop app). On top of that sit a dozen deterministic, no-API-key maps — reading map, core-module ranking, test coverage, git-history hotspots and ownership, tech-debt markers, env-var surface, entry points, external integrations, silent-failure spots, under-documented files, and logic complexity. It all exports offline too: every map stitches into a single `codemap.md`, or a self-contained HTML report you can email to a non-technical stakeholder — no server, no API key, nothing fetched from the network.
211+
The reading experience is already complete end to end: a plain-language project manual, hover annotations, a terminology dictionary, natural-language editing, and snippet Q&A, all in a bilingual UI you launch with one command (or as a native Tauri desktop app). On top of that sit a dozen deterministic, no-API-key maps — reading map, core-module ranking, test coverage, git-history hotspots and ownership, tech-debt markers, env-var surface, entry points, external integrations, silent-failure spots, under-documented files, and logic complexity. It all exports offline too: every map stitches into a single `codemap.md`, or a self-contained HTML report you can email to a non-technical stakeholder — no server, no API key, nothing fetched from the network. Analyses also persist to a small on-disk library (`GET /api/projects`), so you can list past projects and reopen one without remembering its id or re-scanning.
212212

213213
### Planned
214214

@@ -217,7 +217,6 @@ These are the directions I want to take next, roughly in priority order:
217217
- **Pull-request reading mode** — paste a PR link and get the diff explained in plain language: what changed, why it might matter, and which files to look at first. This is the most-requested extension and a natural fit for the existing annotation engine.
218218
- **Whole-project chat** — Q&A today is grounded in one file or snippet; the next step is a conversation that can reach across the project's maps and source at once, while staying honest about what it actually read.
219219
- **Annotation coverage beyond Python** — hover annotations lead with Python today; bringing JavaScript/TypeScript and Go up to the same depth is mostly prompt and tokenizer work.
220-
- **Persistent project library** — the project store is in-memory and single-process today; a small on-disk library would let you reopen past analyses without re-scanning.
221220
- **Jump-to-definition reading** — click a function or import and jump to where it's defined or used, so reading a call doesn't mean losing your place.
222221

223222
Have an idea or a codebase that confuses CodeABC? Open an issue — the roadmap is shaped by what real non-coders get stuck on.

README_CN.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ npm run tauri:dev
190190

191191
### 已交付
192192

193-
阅读体验已经完整跑通:大白话项目说明书、悬停批注、术语词典、自然语言编辑、片段问答,全部在双语界面里,一条命令就能启动(也可以打包成 Tauri 原生桌面应用)。在这之上是十几张无需 API Key 的确定性图谱:阅读路线、核心模块排序、测试覆盖、Git 历史热点与代码归属、技术债标记、环境变量清单、程序入口、外部依赖、错误被吞点、最缺文档的文件,还有逻辑复杂度。这些还能离线导出:所有图谱可以拼成一份 `codemap.md`,或者一份自包含的 HTML 报告,直接发给不懂技术的同事或老板——不用起服务、不用 API Key、不从网上拉任何东西。
193+
阅读体验已经完整跑通:大白话项目说明书、悬停批注、术语词典、自然语言编辑、片段问答,全部在双语界面里,一条命令就能启动(也可以打包成 Tauri 原生桌面应用)。在这之上是十几张无需 API Key 的确定性图谱:阅读路线、核心模块排序、测试覆盖、Git 历史热点与代码归属、技术债标记、环境变量清单、程序入口、外部依赖、错误被吞点、最缺文档的文件,还有逻辑复杂度。这些还能离线导出:所有图谱可以拼成一份 `codemap.md`,或者一份自包含的 HTML 报告,直接发给不懂技术的同事或老板——不用起服务、不用 API Key、不从网上拉任何东西。分析结果还会存进一个小的本地项目库(`GET /api/projects`),可以列出以前分析过的项目、重开其中一个,不用记住它的 id、也不用再扫一遍。
194194

195195
### 后续规划
196196

@@ -199,7 +199,6 @@ npm run tauri:dev
199199
- **PR 阅读模式**:粘贴一个 PR 链接,用大白话讲清楚这次改动改了什么、为什么可能重要、先看哪几个文件。这是被问得最多的扩展,也最贴合现有的批注引擎。
200200
- **整项目对话**:现在的问答只盯着单个文件或片段,下一步是让对话能同时调动项目的各张图谱和源码,同时如实交代它到底读了哪些内容。
201201
- **批注覆盖更多语言**:悬停批注目前优先 Python,把 JavaScript/TypeScript 和 Go 做到同样的深度,主要是 prompt 和分词的工作量。
202-
- **项目库持久化**:现在的项目数据存在内存里、单进程一次性,做一个小的本地项目库后,重开历史分析就不用再扫一遍。
203202
- **跳转到定义**:点一个函数或 import 就跳到它定义、被用的地方,读到一处调用时不会丢失上下文。
204203

205204
有想法,或者有让码上懂犯迷糊的代码库?欢迎开 issue,这份路线图就是跟着真实非程序员卡住的地方走的。

0 commit comments

Comments
 (0)