Problem
Agents starting fresh (subagents, new sessions) have no overview of how shell-config works. They reinvent the wheel, use wrong commands, or modify the wrong files.
Solution
Add ARCHITECTURE.md (or a docs/ section) with:
- What shell-config is in 2 sentences
- Load order:
.zshenv → .zshrc → init.sh → lib/core/ → lib/welcome/ → .zshrc.local
- Key entry points:
init.sh, lib/core/loaders/, lib/welcome/main.sh
- Where to add things: loaders for tools, welcome modules for display, config/ for user settings
- Key env vars:
SHELL_CONFIG_DIR, SHELL_DEBUG, WELCOME_MESSAGE_ENABLED
- How to test:
cd tests && bats **/*.bats
- Line limit: 600 lines per shell file (hook enforced)
Bonus
Reference this file from the CLAUDE.md deployed by install.sh (#14) so agents can Read it for context.
Problem
Agents starting fresh (subagents, new sessions) have no overview of how shell-config works. They reinvent the wheel, use wrong commands, or modify the wrong files.
Solution
Add
ARCHITECTURE.md(or adocs/section) with:.zshenv→.zshrc→init.sh→lib/core/→lib/welcome/→.zshrc.localinit.sh,lib/core/loaders/,lib/welcome/main.shSHELL_CONFIG_DIR,SHELL_DEBUG,WELCOME_MESSAGE_ENABLEDcd tests && bats **/*.batsBonus
Reference this file from the CLAUDE.md deployed by install.sh (#14) so agents can
Readit for context.