Skip to content

Commit 4b640e0

Browse files
committed
chore: update documentation and streamline Zellij layouts
- Revised `CLAUDE.md` to reflect updated Zellij layout names and removed references to deprecated scripts and files. - Simplified the `README.md` by removing mentions of GitHub Copilot instructions and unnecessary setup script details. - Clarified the structure and purpose of configuration linking in the documentation.
1 parent 474e06c commit 4b640e0

3 files changed

Lines changed: 17 additions & 54 deletions

File tree

CLAUDE.md

Lines changed: 14 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -9,57 +9,42 @@ A portable, reproducible terminal development environment (devkit). Not a softwa
99
## Repository Structure
1010

1111
- `brewfile` -- Homebrew package manifest (install with `brew bundle --file=brewfile`)
12-
- `zellij/layouts/` -- KDL layout files for Zellij workspaces (lazyai, fulldev, grove, testrunner, etc.)
13-
- `zellij/launch-lazyai.sh` -- Launcher script; supports `AI_EDITOR` env var (`opencode`, `claude`, etc.)
12+
- `zellij/layouts/` -- KDL layout files for Zellij workspaces (api, database, debug, golang, migrations, monitor, node, pipeline, testrunner)
1413
- `opencode/aig_agents/` -- AI agent persona definitions for OpenCode (advisor, architect, engineer, QA, security, etc.)
1514
- `skills/rules/` -- Always-on coding standards (code quality, engineering principles, security, workflow)
1615
- `skills/commands/` -- On-demand slash commands (refactor-challenge, trace-debug, explain-code, etc.)
1716
- `skills/plane/` -- Plane.so project management commands
1817
- `.claude/rules/` -- Symlinked from `skills/rules/` (single source of truth)
1918
- `.cursor/rules/` -- Cursor rules (same standards, `.mdc` format)
20-
- `.github/copilot-instructions.md` -- GitHub Copilot instructions
2119
- `.config/` -- Tool configs: Ghostty terminal, git-delta, Starship prompt, shell enhancements (zoxide, fzf, eza aliases)
22-
- `scripts/` -- Setup and utility scripts (setup-all.sh, setup-db.sh, setup-ssl.sh, start/stop-services.sh, killport.sh, etc.)
20+
- `scripts/` -- Utility scripts (killport.sh, brew-update.sh, dev-cleanup.sh)
2321

2422
## Key Commands
2523

2624
```bash
27-
# Full environment setup
28-
./scripts/setup-all.sh
29-
3025
# Install/update tools
3126
brew bundle --file=brewfile
3227

33-
# Launch development workspace (God Mode: AI + LazyGit + Shell)
34-
zdev
35-
36-
# Other Zellij layouts
37-
zfull # Editor + LazyGit + Terminal
38-
zgrove # Full-stack multi-tab
39-
ztest # Test runner
40-
zapi # API development
28+
# Zellij layouts
29+
zdebug # Debug workspace with log stacking
30+
ztest # Test runner (unit/integration/E2E)
31+
zmig # Migrations (runner, DB console, queries, seed data)
32+
zapi # API development (server, request logs, test, schema)
33+
zpipe # Pipeline (build, deploy, rollback, container logs)
34+
zmon # Monitor (btop + logs + Docker)
35+
zdb # Database (PostgreSQL + Redis)
4136
znode # Node.js development
4237
zgo # Go development
4338

44-
# Launch with specific AI editor
45-
AI_EDITOR=claude zellij -l zellij/layouts/lazyai.kdl
46-
./zellij/launch-lazyai.sh claude
47-
48-
# Service management
49-
./scripts/start-services.sh # PostgreSQL, Redis, Docker
50-
./scripts/stop-services.sh
51-
brew services list
52-
5339
# Utilities
5440
./scripts/killport.sh <port>
55-
./scripts/setup-db.sh
56-
./scripts/setup-ssl.sh
41+
./scripts/brew-update.sh
42+
./scripts/dev-cleanup.sh
5743
```
5844

5945
## Configuration Linking
6046

61-
Configs are symlinked from this repo to `~/.config/` and `~/`. The setup script handles:
62-
- `.zshrc` -> `~/.zshrc`
47+
Configs are symlinked from this repo to `~/.config/` and `~/`:
6348
- `zellij/` -> `~/.config/zellij/`
6449
- `.config/ghostty/config` -> `~/.config/ghostty/config`
6550
- `.config/git/delta.gitconfig` -> included via `git config --global include.path`
@@ -101,4 +86,4 @@ Frontend design skills (`/audit`, `/polish`, `/critique`, `/animate`, etc.) are
10186
- Shell scripts should use `set -e` and follow existing patterns in `scripts/`
10287
- `skills/rules/` is the single source of truth for always-on rules -- `.claude/rules/` files are symlinks. Edit files in `skills/rules/`, not `.claude/rules/`
10388
- `skills/commands/` and `skills/plane/` are slash commands symlinked into `~/.claude/skills/`
104-
- `.cursor/rules/` and `.github/copilot-instructions.md` are maintained separately in their tool-specific formats -- update them when modifying standards in `skills/`
89+
- `.cursor/rules/` is maintained separately in `.mdc` format -- update when modifying standards in `skills/`

README.md

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ It includes curated CLI tools installed via Homebrew, 9 Zellij layouts for diffe
7171

7272
## AI Tools (Optional)
7373

74-
The repo includes configs for AI coding tools — these are entirely optional and nothing else depends on them. Agent definitions are provided for [OpenCode](https://github.com/anomalyco/opencode), and assistant rules are included for Claude Code, Cursor, and GitHub Copilot.
74+
The repo includes configs for AI coding tools — these are entirely optional and nothing else depends on them. Agent definitions are provided for [OpenCode](https://github.com/anomalyco/opencode), and assistant rules are included for Claude Code and Cursor.
7575

7676
For frontend design skills (`/audit`, `/polish`, `/critique`, `/animate`, `/frontend-design`, etc.), install [Impeccable](https://github.com/pbakaus/impeccable) separately into `~/.claude/skills/`.
7777

@@ -86,7 +86,7 @@ For frontend design skills (`/audit`, `/polish`, `/critique`, `/animate`, `/fron
8686
| **Security** | Vulnerability scanning | `@security` |
8787
| **PM** | Linear integration & project mgmt | `@linear` |
8888

89-
Agent configs live in [`opencode/aig_agents/`](opencode/aig_agents/). Rules live in [`skills/`](skills/) (symlinked into [`.claude/rules/`](.claude/rules/)), [`.cursor/rules/`](.cursor/rules/), and [`.github/copilot-instructions.md`](.github/copilot-instructions.md).
89+
Agent configs live in [`opencode/aig_agents/`](opencode/aig_agents/). Rules live in [`skills/`](skills/) (symlinked into [`.claude/rules/`](.claude/rules/)) and [`.cursor/rules/`](.cursor/rules/).
9090

9191
## Open-Source Tools of Interest
9292

@@ -126,10 +126,6 @@ brew bundle --file=brewfile
126126
**3. Link configurations**
127127

128128
```bash
129-
# Shell
130-
mv ~/.zshrc ~/.zshrc.backup 2>/dev/null || true
131-
ln -sf ~/devkit/.zshrc ~/.zshrc
132-
133129
# Zellij layouts
134130
mkdir -p ~/.config/zellij
135131
ln -sf ~/devkit/zellij/layouts ~/.config/zellij/layouts
@@ -145,12 +141,6 @@ git config --global include.path ~/devkit/.config/git/delta.gitconfig
145141
echo 'source ~/devkit/.config/shell/enhancements.zsh' >> ~/.zshrc
146142
```
147143

148-
Or run the full setup script:
149-
150-
```bash
151-
./scripts/setup-all.sh
152-
```
153-
154144
**4. Reload shell**
155145

156146
```bash
@@ -167,13 +157,4 @@ cd ~/my-svc && zgo # Go project with pre-wired commands
167157
zdebug # Debug workspace with log stacking
168158
```
169159

170-
All tools are keyboard-driven. See [CHEATSHEET.md](CHEATSHEET.md) for keybindings and workflows.
171-
172-
## Documentation
173-
174-
| Doc | What's Inside |
175-
| :--- | :--- |
176-
| [SETUP.md](SETUP.md) | Complete installation, databases, SSL, services |
177-
| [TOOLS.md](TOOLS.md) | Deep dive into every tool with examples |
178-
| [CHEATSHEET.md](CHEATSHEET.md) | Keyboard shortcuts and quick commands |
179-
| [TROUBLESHOOTING.md](TROUBLESHOOTING.md) | Common issues and solutions |
160+
All tools are keyboard-driven. Layout aliases are defined in `.config/shell/enhancements.zsh`.

skills/README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,5 @@ ln -sf ~/devkit/skills/plane ~/.claude/skills/plane
8080
### Cursor
8181
`.cursor/rules/` contains `.mdc` formatted versions of the always-on rules. Maintained separately.
8282

83-
### GitHub Copilot
84-
`.github/copilot-instructions.md` is a curated digest of all rules. Maintained separately.
85-
8683
### OpenCode
8784
Already configured via `opencode/aig_agents/`.

0 commit comments

Comments
 (0)