Add claude/README.md documenting layout and setup script#206
Draft
ikuwow wants to merge 2 commits into
Draft
Conversation
Picks Option A from #173: keep scripts/claude-code-setup.sh where it is, add a README that documents the per-file symlink map and points new sessions at the setup script. Corrects the AGENTS.md statement that previously claimed claude/ was symlinked as a directory. Closes #173. Co-authored-by: Claude Opus 4.6 <[email protected]>
The previous wording said "edit through scripts/claude-code-setup.sh" which would mislead a future reader into thinking the file is generated. The file is the symlinked registry the claude CLI reads; hand-editing is the correct path. The setup script handles server registration (a different concern, already explained in the next section). Co-authored-by: Claude Opus 4.6 <[email protected]>
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.
Closes #173. Picks Option A from the issue (keep
scripts/claude-code-setup.sh, addclaude/README.md).Why
A new session looking at
~/.claude/will not seescripts/claude-code-setup.shand defaults to ad-hocclaude mcp addinvocations. The fix the issue identified was either physical relocation (B/C/D) or a navigation aid (A). Option A is the smallest disruption: every other location proposed in the issue breaks theclaude/ ↔ ~/.claude/mirror invariant or splits "claude-related" between two top-level paths, in exchange for moving one file. The cost-benefit favored navigation aid.What
claude/README.mddocuments the per-file symlink table (with eachdeploy.shrule's intent), the role ofscripts/claude-code-setup.sh, and the MCP env-var convention (hardcoded non-secret values inline;${VAR}only for secrets sourced from~/.bash_profile.local).AGENTS.md(symlinked fromCLAUDE.md): corrects the inaccurate "claude/directory is symlinked to~/.claude/" line — the actual mapping is per-file. Also points new sessions atclaude/README.mdand the setup script.Notes
scripts/deploy.shlines 63-74. Adding a new entry should update both — the README calls that out explicitly.claude/plugins/config.jsonandclaude/routines/*.mdare intentionally listed as "not symlinked" — they are read fromscripts/claude-code-setup.shand persisted in theclaudeCLI's own state, not in~/.claude/.Verification
claude/README.mdcontent cross-checked againstscripts/deploy.shlines 63-74 and the actual subdirectories present underclaude/(agents/,hooks/,plugins/,routines/,rules/,skills/, plus.mcp.json,settings.json,statusline-command.sh).pre-commit runpasses (lint hooks).claude/reads the README and reachesscripts/claude-code-setup.shwithout first attempting direct~/.claude.jsonedits.