Skip to content

docs: drop workspace-path assumption from plugin docs and skills#332

Merged
JacobPEvans merged 1 commit into
mainfrom
chore/drop-workspace-path-assumption
May 25, 2026
Merged

docs: drop workspace-path assumption from plugin docs and skills#332
JacobPEvans merged 1 commit into
mainfrom
chore/drop-workspace-path-assumption

Conversation

@JacobPEvans
Copy link
Copy Markdown
Collaborator

Summary

Follow-up to #330. That PR swapped hardcoded ~/git/... references for ${GIT_HOME_PUBLIC}/<repo>/.... Reviewer pushback: skill docs and convention rules shouldn't bake any local workspace path into prose at all — describe what to do, not where files live.

What changed (10 files)

  • .claude/rules/worktree-conventions.md: convention table shows relative paths (<repo>/main/, <repo>/{branch-name}/). Operational sync line drops cd, frames as "from the main worktree".
  • git-standards/skills/git-workflow-standards/SKILL.md: layout diagram + table use relative paths. Create/Remove commands use ../ from the main worktree.
  • git-workflows/skills/sync-main: "find and sync main" describes the worktree role; drops cd.
  • git-workflows/skills/troubleshoot-worktree: git worktree add ../<branch> (relative).
  • github-workflows/skills/rebase-pr: "from the main worktree" framing.
  • github-workflows/skills/refresh-repo: drop the ${GIT_HOME}/CLAUDE.md citation; drop the ${GIT_HOME_PUBLIC}/<repo>/<default>/ path-resolution rule in favor of git worktree list --porcelain matching on branch refs/heads/<default>; --sweep glob description loosened.
  • infra-orchestration/orchestrate-infra: "locate each target repo's main worktree" instead of a path glob.
  • infra-orchestration/sync-inventory: "from the X main worktree" framing; repo list shows names only.
  • infra-orchestration/test-e2e: same.
  • codeql-resolver/README.md: examples annotate the worktree, drop cd.

Why this PR exists separately from #330

The user merged #330 quickly after open; the further-cleanup amend (this PR's content) didn't have time to apply pre-merge. Splitting into a follow-up keeps history clean rather than force-pushing already-merged content.

Related

Assisted-by: Claude noreply@anthropic.com

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates various documentation and skill files to remove absolute paths referencing ${GIT_HOME_PUBLIC} and replace them with relative paths or context-aware instructions, aligning the documentation with a more flexible workspace layout. The feedback suggests removing a redundant git switch main command when syncing from the main worktree, as the main branch is already checked out in that directory.

Comment thread .claude/rules/worktree-conventions.md Outdated
@JacobPEvans JacobPEvans force-pushed the chore/drop-workspace-path-assumption branch 2 times, most recently from 7a9729e to 32b4137 Compare May 25, 2026 22:24
PR #330 swapped hardcoded `~/git/...` for `${GIT_HOME_PUBLIC}/<repo>/...`.
Reviewer follow-up: skill docs should not bake a workspace path
convention into prose either — describe what to do, not where files live.

Changes (10 files):
- .claude/rules/worktree-conventions.md: convention table now shows
  relative paths (`<repo>/main/`, `<repo>/{branch-name}/`). Operational
  "switch to main and sync" line drops the `cd`, says "From the main
  worktree, sync".
- git-standards/skills/git-workflow-standards/SKILL.md: layout diagram +
  table use relative paths. Create/Remove commands use `../` from the
  main worktree.
- git-workflows/skills/sync-main: "find and sync main" describes the
  worktree role; drops `cd`.
- git-workflows/skills/troubleshoot-worktree: `git worktree add ../<branch>`
  (relative).
- github-workflows/skills/rebase-pr: "from the main worktree" framing.
- github-workflows/skills/refresh-repo: drops the `${GIT_HOME}/CLAUDE.md`
  citation (just "per the workspace convention"); drops the
  `${GIT_HOME_PUBLIC}/<repo>/<default>/` path-resolution rule in favor of
  `git worktree list --porcelain` matching on `branch refs/heads/<default>`;
  --sweep glob description loosened.
- infra-orchestration/orchestrate-infra: "locate each target repo's main
  worktree" instead of a path glob.
- infra-orchestration/sync-inventory: "from the X main worktree" framing;
  repo list shows names only, not paths.
- infra-orchestration/test-e2e: same.
- codeql-resolver/README.md: examples annotate the worktree, drop `cd`.

The `${GIT_HOME}` / `${GIT_HOME_PUBLIC}` nix-home sessionVariables still
exist for workspace tooling — this PR just stops mentioning them in
plugin docs where they're not load-bearing.

Assisted-by: Claude <noreply@anthropic.com>
@JacobPEvans JacobPEvans force-pushed the chore/drop-workspace-path-assumption branch from 32b4137 to 6f0ff07 Compare May 25, 2026 22:51
@JacobPEvans JacobPEvans merged commit 789cb43 into main May 25, 2026
8 checks passed
@JacobPEvans JacobPEvans deleted the chore/drop-workspace-path-assumption branch May 25, 2026 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant