Skip to content

docs: add overlay creation guidance#16

Merged
dlovell merged 1 commit into
mainfrom
docs/overlay-guide
May 31, 2026
Merged

docs: add overlay creation guidance#16
dlovell merged 1 commit into
mainfrom
docs/overlay-guide

Conversation

@dlovell

@dlovell dlovell commented May 31, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add two conventions to CLAUDE.md: prefer uv sync --group dev over legacy --dev when targeting a specific group, and strip inherited dead weight when creating overlays
  • Create projects/README.md with guidance on creating new overlays: start from closest existing overlay, cargo volume topology (shared vs per-worktree), external-volumes.txt registration, and artifact-gated build steps

Follow-up from #14 (batchcorder overlay) — documents learnings from that process for future overlay authors.

Test plan

  • Review that guidance matches current overlay patterns

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@dlovell dlovell force-pushed the docs/overlay-guide branch from b3f4a66 to 41b5169 Compare May 31, 2026 13:57
@dlovell dlovell marked this pull request as ready for review May 31, 2026 14:07
@dlovell dlovell merged commit e3573b3 into main May 31, 2026
6 checks passed
@dlovell dlovell deleted the docs/overlay-guide branch May 31, 2026 14:08
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