[docs] enhance documentation structure and content#66
Merged
wangxiyu191 merged 1 commit intomainfrom Mar 20, 2026
Merged
Conversation
Collaborator
wangxiyu191
commented
Mar 20, 2026
- Improve development and testing guides
- Add basic concepts introduction
- Add AGENTS.md for agent collaboration
- Improve development and testing guides - Add basic concepts introduction - Add AGENTS.md for agent collaboration
oldsharp
approved these changes
Mar 20, 2026
There was a problem hiding this comment.
👋 Review Summary
文档结构和内容这次整理得很清晰:基础概念、开发流程、测试与调试路径都串了起来,对后续贡献者理解整体架构和如何本地跑起来会有很大帮助。
🛡️ Key Risks & Issues
- 测试资源清理部分使用
pkill -f kv_cache_manager_bin的示例,如果在共享开发机或还在跑其他 kv_cache_manager 进程的环境下直接照抄,有可能误杀非测试进程,影响其他工作负载。建议在文档里明确这是在本地、隔离测试环境下的建议命令,或者给一个更窄的匹配方式示例(例如结合特定工作目录或启动参数)。
🧪 Verification Advice
- 建议按照文档中新补充的命令实际在干净环境下跑一遍单测、集成测试以及 Redis 相关测试,确认所有命令都可以直接通过拷贝执行。
- Redis/Valkey 相关测试建议在本地使用单独的实例或端口验证一遍,确保不会对已有数据产生影响,可以在文档中顺带强调一下这一点。
💡 Thoughts & Suggestions
- 基本概念文档对 Storage / Instance Group / Instance 以及 Block / CacheLocation / LocationSpec 的定义和约束写得比较凝练准确,后续如果有新的重要系统级约束(比如复用策略、配额策略变化),可以优先同步到 AGENTS.md 和 basic_concepts 里,保持“约束”和“概念”的单一事实来源。
- 调试章节对日志位置和典型排查流程的拆解非常实用,后续可以考虑在遇到典型问题时(例如 cache 命中率异常、写入超时)补充几个“小案例”链接,作为进一步的排障手册。
🤖 Generated by Qoder • View workflow run
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.