docs: split README into docs/, add CLI reference#37
Merged
Conversation
- slim README.md / README_CN.md to an overview that links into docs/ - add docs/cli.md — full grove CLI reference (was missing entirely) - move hook + config details into docs/hooks.md and docs/configuration.md - make AGENTS.md a symlink to CLAUDE.md (single source of truth)
- swap screenshot to docs/grove_0.13.1.png in both READMEs - use snake_case worktree_root in grove config examples (kebab form is rejected)
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
1 participant
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.
背景
groveCLI 的用法文档此前完全缺失（README 里只提了open/hook/worktree list几条，detach/attach/rm/config/cd/shell-init 等都没写）AGENTS.md与CLAUDE.md内容割裂，需要双份维护改动
README.md/README_CN.md改为简洁概览（功能一览 + Getting Started + 文档入口），细节移入docs/并链接。两个 README 保持对称，互相加了语言切换链接。docs/cli.md— 完整的groveCLI 参考：命令总览表、worktree new/detach/attach/rm全部参数、hook run/list/edit、config show/get/set/unset/path/edit、cd与shell-init，含安装方式和脚本化示例。docs/hooks.md（生命周期事件、4 种步骤类型、模板变量）、docs/configuration.md（配置层级、设置项、store.json存储）。AGENTS.md→CLAUDE.md软链接 — 以 git symlink（mode120000）提交，CLAUDE.md成为唯一事实来源。校对要点
src-tauri/src/cli.rs.claude（与config.rs一致）grove config的 key 用 snake/camel（worktree_root），而 TOML 配置文件用 kebab（worktree-root）—— 两者不同，容易踩坑纯文档改动，不影响构建。