Skip to content

[docs] enhance documentation structure and content#66

Merged
wangxiyu191 merged 1 commit intomainfrom
docs/add-agentsmd
Mar 20, 2026
Merged

[docs] enhance documentation structure and content#66
wangxiyu191 merged 1 commit intomainfrom
docs/add-agentsmd

Conversation

@wangxiyu191
Copy link
Collaborator

  • 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
@wangxiyu191 wangxiyu191 requested a review from oldsharp March 20, 2026 09:56
Copy link

@qoderai qoderai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👋 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 QoderView workflow run

@github-actions github-actions bot added the ai reviewed AI has reviewed this PR label Mar 20, 2026
@wangxiyu191 wangxiyu191 merged commit 36d9b34 into main Mar 20, 2026
9 checks passed
@wangxiyu191 wangxiyu191 deleted the docs/add-agentsmd branch March 20, 2026 10:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai reviewed AI has reviewed this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants