Skip to content

Commit fc4e6b7

Browse files
committed
docs: simplify and update documentation
- Remove nushell/sketchybar references (configs removed) - Remove contributing section - Add codebase-summary.md - Simplify docs/index.md navigation - Update temporal.md to proper stub
1 parent 45f0171 commit fc4e6b7

4 files changed

Lines changed: 211 additions & 75 deletions

File tree

README.md

Lines changed: 27 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,26 @@ A comprehensive, AI-enhanced development environment for macOS featuring tiling
66
![macOS](https://img.shields.io/badge/macOS-000000?style=for-the-badge&logo=apple&logoColor=white)
77
![Neovim](https://img.shields.io/badge/NeoVim-%2357A143.svg?&style=for-the-badge&logo=neovim&logoColor=white)
88
![Tmux](https://img.shields.io/badge/tmux-1BB91F?style=for-the-badge&logo=tmux&logoColor=white)
9-
![Nushell](https://img.shields.io/badge/Nushell-4E9A06?style=for-the-badge&logo=gnu-bash&logoColor=white)
109
![Zsh](https://img.shields.io/badge/Zsh-F15A24?style=for-the-badge&logo=gnu-bash&logoColor=white)
1110

1211
## ✨ Features
1312

1413
### 🤖 AI-Enhanced Development
1514
- **CodeCompanion** - AI chat and inline assistance
16-
- **GitHub Copilot** - Primary AI code completion with ergonomic keybindings
15+
- **GitHub Copilot** - Code completion with ergonomic keybindings
1716
- **Database AI** - AI-powered SQL assistance
1817
- **Unified AI System** - Streamlined AI completion with conflict prevention
1918

2019
### 🪟 Window Management
2120
- **Yabai** - Tiling window manager with BSP layout
2221
- **SKHD** - Hotkey daemon for seamless app switching
23-
- **Sketchybar** - Custom status bar with system info
22+
- **Karabiner** - Advanced keyboard customization
2423

2524
### 💻 Terminal & Shell
26-
- **Nushell** - Modern shell with structured data processing (primary)
27-
- **Zsh** with Oh My Zsh and Powerlevel10k (maintained)
25+
- **Zsh** with Oh My Zsh and Powerlevel10k
2826
- **Tmux** with custom keybindings and session management
29-
- **Ghostty** - Modern terminal emulator with Nushell integration
30-
- **Starship** - Cross-shell prompt with P10K-inspired lean theme
27+
- **Ghostty** - Modern terminal emulator (primary)
28+
- **Starship** - Cross-shell prompt with modern styling
3129

3230
### 🛠️ Development Tools
3331
- **Neovim** - AstroNvim v5 with LSP, treesitter, and AI
@@ -89,10 +87,8 @@ dotfiles/
8987
├── kitty/ # Kitty terminal config
9088
├── lazygit/ # Git TUI configuration
9189
├── mise/ # Runtime version manager
92-
├── nushell/ # Nushell configuration with Starship theme
9390
├── nvim/ # Neovim configuration (AstroNvim)
9491
├── nvim-vscode/ # VSCode Neovim integration
95-
├── sketchybar/ # Status bar configuration
9692
├── skhd/ # Hotkey daemon config
9793
├── starship/ # Shell prompt config
9894
├── task/ # Task runner config
@@ -145,19 +141,14 @@ dotfiles/
145141
| `<C-f>` | Project Sessionizer |
146142
| `-` | File Manager (Oil) |
147143

148-
### Nushell (Primary Shell)
144+
### Zsh Utilities
149145
| Command | Action |
150146
|---------|--------|
151147
| `yy [args]` | Yazi file manager with directory change |
152148
| `nvim-select` or `nv` | Select file to edit with Neovim |
153-
| `nvim-config [type]` or `nc` | Quick edit config files |
154-
| `edit-config` | Edit Nushell configuration |
155-
| `edit-env` | Edit Nushell environment |
156-
| `starship-lean` or `st-lean` | Switch to lean P10K-style theme |
157-
| `starship-full` or `st-full` | Switch to full Starship theme |
158-
| `starship-info` or `st-info` | Show current theme info |
159-
| `ghcs <cmd>` | GitHub Copilot suggest command |
160-
| `ghce <cmd>` | GitHub Copilot explain command |
149+
| `p10k configure` | Configure Powerlevel10k theme |
150+
| `tmux-sessionizer` | Quick project switcher in Tmux |
151+
| `source ~/.zshrc` | Reload shell configuration |
161152

162153
### AI Completion (GitHub Copilot)
163154
| Shortcut | Action |
@@ -174,17 +165,17 @@ dotfiles/
174165

175166
### Neovim Features
176167
- **AstroNvim v5** - Modern Neovim distribution
177-
- **AI Integration** - Multiple AI assistants for coding
178-
- **Database Tools** - Advanced SQL development with MFA support
168+
- **AI Integration** - Multiple AI assistants (Copilot, CodeCompanion)
169+
- **Database Tools** - Advanced SQL development with Snowflake support
179170
- **LSP Support** - Language servers for multiple languages
180171
- **Custom Dashboard** - Branded startup screen
181172

182-
### Nushell Shell
183-
- **Structured Data** - Built-in JSON, CSV, SQL processing
184-
- **Modern Features** - Fuzzy completion, vi-mode editing
185-
- **Starship Integration** - P10K-inspired lean theme with Catppuccin colors
173+
### Zsh Shell
174+
- **Oh My Zsh** - Framework with plugins and themes
175+
- **Powerlevel10k** - Feature-rich prompt with instant feedback
176+
- **Starship Theme** - Modern alternative prompt configuration
186177
- **Tool Integration** - Atuin history, Zoxide navigation, Direnv support
187-
- **Theme Switching** - Easy toggle between lean and full prompt themes
178+
- **Shell Aliases** - Atuin-managed aliases with import/export
188179

189180
### Tmux Workflow
190181
- **Project Sessionizer** - Quick project switching with FZF
@@ -195,8 +186,8 @@ dotfiles/
195186
### Window Management
196187
- **BSP Layout** - Binary space partitioning for optimal screen usage
197188
- **Smart Gaps** - 5px gaps with toggle functionality
198-
- **App Rules** - Specific behavior for different applications
199-
- **Mouse Integration** - Fn + mouse for window manipulation
189+
- **App Rules** - Specific window behavior per application
190+
- **Hotkey System** - Modal shortcuts with SKHD
200191

201192
## 🛠️ Customization
202193

@@ -211,8 +202,8 @@ dotfiles/
211202
- **Tmux bindings**: Edit `dotfiles/tmux/.tmux.conf`
212203

213204
### Shell & Terminal Configuration
214-
- **Nushell Setup**: See `docs/NUSHELL_SETUP.md` - Modern shell configuration
215-
- **Zsh Fallback**: Original zsh config maintained for compatibility
205+
- **Zsh Setup**: Primary shell with Oh My Zsh and Powerlevel10k
206+
- **Ghostty**: Modern terminal emulator with optimized settings
216207

217208
### AI Configuration
218209
See documentation in `dotfiles/nvim/.config/nvim/docs/`:
@@ -229,23 +220,22 @@ make stow-install # Install all dotfiles
229220
make stow-clean # Remove all symlinks
230221

231222
# System maintenance
232-
./scripts/macos-deps.sh # Install dependencies
233-
./scripts/yabai-upgrade.sh # Upgrade window manager
223+
./scripts/macos-deps.sh # Install macOS dependencies
224+
./scripts/yabai-upgrade.sh # Upgrade Yabai window manager
234225

235226
# Alias management (Atuin)
236227
make export-aliases # Export current aliases to file
237228
make import-aliases # Import aliases from file
238229
make backup-aliases # Export and commit aliases to git
239230

240231
# Tmux utilities
241-
~/.local/bin/tmux-sessionizer # Project switcher
242-
~/.local/bin/tmux-windowizer # Window manager
232+
~/.local/bin/tmux-sessionizer # Quick project switcher
233+
~/.local/bin/tmux-windowizer # Window/pane management
243234

244-
# Nushell utilities
245-
starship-lean # Switch to lean P10K-style theme
246-
starship-full # Switch to full Starship theme
235+
# Utilities
247236
nvim-select # Interactive file selection for editing
248237
yy # Yazi file manager with directory change
238+
p10k configure # Configure Powerlevel10k prompt
249239
```
250240

251241
## 🔍 Troubleshooting
@@ -276,15 +266,7 @@ git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm
276266
- Verify network connectivity
277267
- See individual setup guides in `docs/` folder
278268

279-
## 🤝 Contributing
280-
281-
1. Fork the repository
282-
2. Create a feature branch
283-
3. Make your changes
284-
4. Test thoroughly
285-
5. Submit a pull request
286-
287-
## 📚 References & Inspiration
269+
## 📚 References
288270

289271
- [GNU Stow Guide](https://dr563105.github.io/blog/manage-dotfiles-with-gnu-stow/)
290272
- [AstroNvim Documentation](https://docs.astronvim.com/)

docs/codebase-summary.md

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
# Codebase Summary
2+
3+
Duc's Digital Workspace: AI-enhanced macOS development environment with 22 dotfiles packages managed via GNU Stow.
4+
5+
## Structure Overview
6+
7+
### Core Packages (22 total)
8+
9+
**Editors & IDEs:**
10+
- `nvim` - Neovim with AstroNvim v5 distribution
11+
- `nvim-vscode` - VSCode Neovim integration
12+
- `vscode` - VSCode settings and keybindings
13+
14+
**Terminal & Shell:**
15+
- `zsh` - Primary shell configuration with Oh My Zsh
16+
- `tmux` - Terminal multiplexer with custom plugins
17+
- `ghostty` - Modern terminal emulator
18+
- `kitty` - Alternative terminal emulator
19+
- `atuin` - Intelligent shell history with sync
20+
- `starship` - Cross-shell prompt configuration
21+
22+
**Window Management:**
23+
- `yabai` - Tiling window manager (BSP layout)
24+
- `skhd` - Hotkey daemon for app switching
25+
- `karabiner` - Keyboard customization
26+
- `hammerspoon` - macOS automation scripts
27+
28+
**File & Git Management:**
29+
- `yazi` - File manager with custom plugins
30+
- `lazygit` - Git TUI configuration
31+
- `bin` - Custom scripts (tmux-sessionizer, git-worktree-manager, etc.)
32+
33+
**Development Tools:**
34+
- `direnv` - Automatic environment loading
35+
- `mise` - Runtime version management
36+
- `task` - Task runner configuration
37+
- `zathura` - PDF viewer configuration
38+
39+
**Other:**
40+
- `claude` - Claude AI user configuration
41+
- `vrapperrc` - Vim keybindings for Eclipse
42+
43+
### Scripts (13 scripts)
44+
45+
**Installation & Setup:**
46+
- `scripts/macos-deps.sh` - Install macOS dependencies
47+
- `scripts/ci/` - CI pipeline scripts (validate, check-dependencies, test-platforms)
48+
49+
**Neovim Management:**
50+
- `scripts/nvim-install-parser.sh` - Install treesitter parsers
51+
- `scripts/nvim-treesitter-arm64.sh` - ARM64 specific setup
52+
- `scripts/refresh-nvim.sh` - Refresh Neovim plugins
53+
54+
**Maintenance:**
55+
- `scripts/yabai-upgrade.sh` - Update window manager
56+
- `scripts/export-atuin-aliases.sh` - Export shell aliases
57+
- `scripts/import-atuin-aliases.sh` - Import shell aliases
58+
- `scripts/appscript-notifications.scpt` - macOS notifications
59+
60+
### Configuration Files
61+
62+
- `Makefile` - Build automation (stow install/clean, alias management)
63+
- `.stow-local-ignore` - GNU Stow ignore patterns
64+
- `.repomixignore` - Repomix packing exclusions
65+
- `.gitleaksignore` - Secrets scanning exclusions
66+
- `.gitignore` - Git ignore patterns
67+
- `zensical.toml` - Documentation site configuration
68+
- `mise.toml` - Runtime version specifications
69+
- `CLAUDE.md` - Claude AI project instructions
70+
71+
### Documentation
72+
73+
- `docs/` - Main documentation folder with guides for all tools
74+
- `dotfiles/nvim/.config/nvim/docs/` - Neovim-specific AI documentation
75+
76+
## Key Features
77+
78+
### Window Management
79+
- **Yabai** - Binary space partitioning with 5px gaps
80+
- **SKHD** - Modal hotkey system with app shortcuts
81+
- **App Rules** - Specific window behavior per application
82+
83+
### AI Integration
84+
- **GitHub Copilot** - Code completion with custom keybindings
85+
- **CodeCompanion** - OpenAI chat and inline assistance
86+
- **Database AI** - SQL-specific AI helpers
87+
- **Unified System** - Conflict prevention across AI tools
88+
89+
### Terminal Workflows
90+
- **Tmux** - Session management with custom plugins
91+
- **Atuin** - Command history with cloud sync
92+
- **Starship** - Modern shell prompt with themes
93+
- **Ghostty** - Primary terminal with modern features
94+
95+
### Development Environment
96+
- **AstroNvim** - Modern Neovim distribution
97+
- **Language Servers** - LSP support for multiple languages
98+
- **Database Tools** - Advanced SQL with Snowflake support
99+
- **Version Management** - Mise for runtime versions
100+
101+
## Dependencies
102+
103+
**System:**
104+
- macOS 12.0+
105+
- Homebrew
106+
- Git
107+
- GNU Stow
108+
109+
**Installed via Scripts:**
110+
- Neovim + plugins
111+
- Tmux + TPM
112+
- Terminal emulators (Ghostty, Kitty)
113+
- Development tools (Node, Python, Rust)
114+
- Window managers (Yabai, SKHD)
115+
116+
## File Statistics
117+
118+
- Total Files: 102
119+
- Total Tokens: 126,785
120+
- Configuration-heavy (minimal code)
121+
- Well-documented with inline comments
122+
123+
## Maintenance
124+
125+
**Key Files for Updates:**
126+
- `Makefile` - Installation procedures
127+
- `README.md` - Public documentation
128+
- `CLAUDE.md` - Development instructions
129+
- `dotfiles/nvim/` - Editor configuration
130+
- `dotfiles/zsh/.zshrc` - Shell setup
131+
132+
**Common Tasks:**
133+
- Stow install/clean: `make stow-install/clean`
134+
- Alias management: `make export/import-aliases`
135+
- Service restart: `brew services restart yabai skhd`
136+
- Plugin updates: `:Lazy sync` (Neovim), `prefix + I` (Tmux)
137+
138+
## Documentation Hierarchy
139+
140+
1. **Installation** - Setup from scratch
141+
2. **Quick Reference** - Essential commands
142+
3. **Tool Guides** - Detailed configuration (Tmux, SKHD, Atuin, etc.)
143+
4. **Troubleshooting** - Common issues and fixes
144+
5. **AI Workflows** - Best practices for AI tools
145+
6. **Advanced** - Custom configurations and extensions

docs/index.md

Lines changed: 31 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,42 @@
11
---
22
title: Home
3-
description: Comprehensive AI-enhanced development environment for macOS
3+
description: AI-enhanced macOS development environment documentation
44
---
55

66
# Duc's Digital Workspace
77

8-
Welcome to the comprehensive documentation for this modern macOS development environment. This wiki contains detailed guides, troubleshooting tips, and configuration options for all components.
8+
Welcome to the comprehensive documentation for this modern macOS development environment. Quick setup, configuration guides, and troubleshooting for all tools.
99

1010
## Getting Started
1111

12-
- [Installation Guide](installation.md) - Complete setup instructions
12+
- [Installation Guide](installation.md) - Complete setup from scratch
1313
- [Quick Reference](quick-reference.md) - Essential commands and shortcuts
14+
- [Troubleshooting](troubleshooting.md) - Common issues and solutions
1415

15-
## Core Tools
16+
## Core Tools Documentation
1617

17-
- [Neovim](neovim/README.md) - Editor configuration and plugins
18-
- [Zen Mode](zen-mode.md) - Distraction-free coding environment
19-
- [Tmux](tmux.md) - Terminal multiplexer setup and workflows
20-
- [Atuin](atuin.md) - Intelligent shell history and sync
21-
- [SKHD](skhd.md) - Hotkey daemon configuration
18+
**Terminal & Multiplexing:**
19+
- [Tmux Setup](tmux.md) - Terminal multiplexer configuration
20+
- [Atuin](atuin.md) - Shell history and sync
2221

23-
## AI Tools
22+
**Window Management:**
23+
- [SKHD Configuration](skhd.md) - Hotkey daemon setup
2424

25-
- [AI Workflows](ai/workflows.md) - Best practices and tips for AI-assisted development
25+
**Editors & IDE:**
26+
- [Neovim Configuration](neovim/README.md) - AstroNvim v5 setup
2627

27-
## Workflows
28-
29-
- [Development Workflows](workflows/development.md) - Daily development patterns
30-
- [Temporal](temporal.md) - Workflow orchestration
28+
**Development Workflows:**
29+
- [Zen Mode](zen-mode.md) - Distraction-free coding with Tmux
30+
- [AI Workflows](ai/workflows.md) - Best practices for AI-assisted coding
3131

3232
## Quick Help
3333

3434
### Common Commands
3535

3636
```bash
37-
# Restart window manager
38-
skhd --restart-service
39-
yabai --restart-service
37+
# Restart services
38+
brew services restart yabai
39+
brew services restart skhd
4040

4141
# Reload configurations
4242
tmux source-file ~/.tmux.conf
@@ -53,14 +53,21 @@ prefix + I # In Tmux
5353
# If window manager breaks
5454
killall yabai skhd
5555
brew services restart yabai
56-
brew services restart skhd
5756

58-
# If terminal is broken
57+
# If terminal breaks
5958
/Applications/Ghostty.app/Contents/MacOS/ghostty
6059
```
6160

62-
### Getting Help
61+
## Documentation Structure
62+
63+
1. **Installation** - Setup procedures and requirements
64+
2. **Quick Reference** - Shortcuts and common commands
65+
3. **Tool-Specific Guides** - Detailed configuration docs
66+
4. **Troubleshooting** - Debug and fix common issues
67+
5. **Workflows** - AI integration and daily patterns
68+
69+
## File & Links
6370

64-
- Check the [Troubleshooting Guide](troubleshooting.md)
65-
- Review configuration files in `dotfiles/`
66-
- Check the main README for basic setup
71+
- [Codebase Summary](../docs/codebase-summary.md) - Project structure overview
72+
- [Main README](../README.md) - Feature highlights and badges
73+
- [Neovim Docs](../dotfiles/nvim/.config/nvim/docs/) - AI tools and plugins

0 commit comments

Comments
 (0)