Skip to content

docs: complete documentation overhaul to match actual configs#10

Open
kbrdn1 wants to merge 2 commits intomainfrom
claude/update-repo-documentation-zOyrW
Open

docs: complete documentation overhaul to match actual configs#10
kbrdn1 wants to merge 2 commits intomainfrom
claude/update-repo-documentation-zOyrW

Conversation

@kbrdn1
Copy link
Owner

@kbrdn1 kbrdn1 commented Feb 25, 2026

  • README.md: Update Stack Overview (Zed primary, Neovim secondary),
    rewrite AeroSpace section (8 workspaces, Karabiner right Option → Ctrl+Alt),
    rewrite Tmux section (home.nix: Ctrl+A prefix, Claude Dark, sesh, tmux.nvim),
    add missing CLI tools (70+ packages), fix aliases (remove wrong cd→zoxide,
    add z/ad/laravel/yt/gg), complete rewrite of Zed keybindings section
    with all Vim leader bindings, File Explorer, and Git Panel shortcuts
  • MIGRATION-YABAI-TO-AEROSPACE.md: Rewrite to reflect actual architecture
    (AeroSpace native keybindings, no skhd, Karabiner right Option mapping)
  • MIGRATION_NIX.md: Update home.nix snapshot, fix CLI tools list,
    update package count to 70+, fix theme references to Claude Dark
  • MIGRATION_HOMEBREW.md: Remove skhd/yabai references, add karabiner,
    update chezmoi to Nix, fix package counts
  • Delete obsolete PLAN_MIGRATION_NIX.md

https://claude.ai/code/session_011v8CcES2CC9k3A7qiF31tG

- README.md: Update Stack Overview (Zed primary, Neovim secondary),
  rewrite AeroSpace section (8 workspaces, Karabiner right Option → Ctrl+Alt),
  rewrite Tmux section (home.nix: Ctrl+A prefix, Claude Dark, sesh, tmux.nvim),
  add missing CLI tools (70+ packages), fix aliases (remove wrong cd→zoxide,
  add z/ad/laravel/yt/gg), complete rewrite of Zed keybindings section
  with all Vim leader bindings, File Explorer, and Git Panel shortcuts
- MIGRATION-YABAI-TO-AEROSPACE.md: Rewrite to reflect actual architecture
  (AeroSpace native keybindings, no skhd, Karabiner right Option mapping)
- MIGRATION_NIX.md: Update home.nix snapshot, fix CLI tools list,
  update package count to 70+, fix theme references to Claude Dark
- MIGRATION_HOMEBREW.md: Remove skhd/yabai references, add karabiner,
  update chezmoi to Nix, fix package counts
- Delete obsolete PLAN_MIGRATION_NIX.md

https://claude.ai/code/session_011v8CcES2CC9k3A7qiF31tG
Copilot AI review requested due to automatic review settings February 25, 2026 05:15
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates and reconciles repository documentation to reflect the current dotfiles setup (Nix/Home Manager, AeroSpace + Karabiner, Zed-first editor workflow) and removes obsolete migration planning docs.

Changes:

  • Overhauls README stack overview, tool lists/aliases, and Zed/AeroSpace/Tmux keybinding documentation.
  • Updates migration guides to match the current architecture (AeroSpace native bindings, Karabiner right-Option mapping, updated package counts).
  • Deletes obsolete PLAN_MIGRATION_NIX.md.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
README.md Aligns README with actual stack (Zed primary, AeroSpace+Karabiner, expanded CLI tools/aliases, updated keybindings).
PLAN_MIGRATION_NIX.md Removes outdated migration plan document.
MIGRATION_NIX.md Updates Nix migration doc to new package list/theme/tooling snapshot and current status.
MIGRATION_HOMEBREW.md Updates Homebrew migration doc to remove skhd/yabai and reflect karabiner + new counts.
MIGRATION-YABAI-TO-AEROSPACE.md Rewrites migration guide for AeroSpace native bindings and Karabiner mapping architecture.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

README.md Outdated
| **Primary Editor** | Zed | Modern code editor with AI integration |
| **Secondary Editor** | Neovim + LazyVim | Terminal editor with LSP, Claude Code integration |
| **Terminal** | Ghostty + Kitty + Tmux | GPU terminals with multiplexer (Claude Dark theme) |
| **Window Manager** | AeroSpace + Karabiner | Tiling window manager (no SIP required) |
Copy link

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

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

The stack table lists the window manager layer as “AeroSpace + Karabiner”, but the rest of the README explicitly refers to “Karabiner-Elements”. For clarity and consistency (and to avoid confusion with other Karabiner variants), rename the stack entry to “AeroSpace + Karabiner-Elements”.

Suggested change
| **Window Manager** | AeroSpace + Karabiner | Tiling window manager (no SIP required) |
| **Window Manager** | AeroSpace + Karabiner-Elements | Tiling window manager (no SIP required) |

Copilot uses AI. Check for mistakes.
Comment on lines +313 to +314
> [!NOTE]
> **Karabiner-Elements** maps the **right Option key** (`⌥→`) to `Ctrl+Alt`, which is the modifier used in AeroSpace bindings.
Copy link

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

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

The stack table lists the window manager layer as “AeroSpace + Karabiner”, but the rest of the README explicitly refers to “Karabiner-Elements”. For clarity and consistency (and to avoid confusion with other Karabiner variants), rename the stack entry to “AeroSpace + Karabiner-Elements”.

Copilot uses AI. Check for mistakes.
README.md Outdated
Comment on lines 136 to 137
| [Oh My Zsh](https://ohmyz.sh/) | Latest | Nix | Zsh framework |
| [Powerlevel10k](https://github.com/romkatv/powerlevel10k) | Latest | Nix | Zsh theme |
Copy link

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

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

There’s an inconsistency: the tooling table says Oh My Zsh / Powerlevel10k are “Managed By: Nix”, but the installation steps still instruct a manual Oh My Zsh install script. Update one side so they match (either change the table to reflect manual install, or adjust the installation steps to describe enabling them via Home Manager).

Suggested change
| [Oh My Zsh](https://ohmyz.sh/) | Latest | Nix | Zsh framework |
| [Powerlevel10k](https://github.com/romkatv/powerlevel10k) | Latest | Nix | Zsh theme |
| [Oh My Zsh](https://ohmyz.sh/) | Latest | Manual | Zsh framework |
| [Powerlevel10k](https://github.com/romkatv/powerlevel10k) | Latest | Manual | Zsh theme |

Copilot uses AI. Check for mistakes.
@@ -597,7 +773,7 @@ This script performs a complete installation:
| **4. Nix Config** | `git clone https://github.com/kbrdn1/nix-config.git ~/nix-config` | Clone Nix configuration |
| **5. Oh My Zsh** | `sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"` | Install Zsh framework |
Copy link

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

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

There’s an inconsistency: the tooling table says Oh My Zsh / Powerlevel10k are “Managed By: Nix”, but the installation steps still instruct a manual Oh My Zsh install script. Update one side so they match (either change the table to reflect manual install, or adjust the installation steps to describe enabling them via Home Manager).

Copilot uses AI. Check for mistakes.
@@ -685,5 +684,5 @@ Impact:

**Dernière mise à jour** : Novembre 2025
Copy link

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

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

This document was updated in this PR (e.g., counts and tool lists), but the “Dernière mise à jour” field still says Novembre 2025. Please update it to reflect the actual edit date to avoid confusing readers about how current the migration guidance is.

Suggested change
**Dernière mise à jour** : Novembre 2025
**Dernière mise à jour** : Février 2026

Copilot uses AI. Check for mistakes.

- **Date**: Août-Septembre 2025
- **Statut**: ✅ Migration complète et fonctionnelle
- **Date**: Aout-Septembre 2025
Copy link

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

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

The French text introduces multiple spelling/orthography regressions (missing accents), and it’s inconsistent with other docs in this PR that keep accents. Consider restoring correct French spelling (e.g., “Août”, “Problèmes”, “capturé”, “système”, “Nécessite”, “désactivation”, “Stabilité”, “Complexité”, “accessibilité”) or add a brief note explaining an intentional ASCII-only policy.

Copilot uses AI. Check for mistakes.
Comment on lines 14 to 18
### Problemes avec Yabai
1. **Conflits macOS**: Alt+Tab capture par le systeme
2. **SIP Required**: Necessite desactivation System Integrity Protection
3. **Stabilite**: Crashes occasionnels
4. **Permissions**: Complexite des permissions d'accessibilite
Copy link

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

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

The French text introduces multiple spelling/orthography regressions (missing accents), and it’s inconsistent with other docs in this PR that keep accents. Consider restoring correct French spelling (e.g., “Août”, “Problèmes”, “capturé”, “système”, “Nécessite”, “désactivation”, “Stabilité”, “Complexité”, “accessibilité”) or add a brief note explaining an intentional ASCII-only policy.

Copilot uses AI. Check for mistakes.
README.md Outdated
Comment on lines 80 to 84
| [Node.js](https://nodejs.org/) | 24.x | Nix | JavaScript runtime |
| [Python](https://www.python.org/) | 3.13.x | Nix | Python interpreter |
| [PHP](https://www.php.net/) | 8.4.x | Nix | With pcov, redis extensions |
| [Go](https://golang.org/) | Latest | Nix | Golang compiler |
| [Rust](https://www.rust-lang.org/) | Latest | Nix | Rust toolchain (rustc, cargo, clippy, rustfmt) |
Copy link

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

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

Using “Latest”/“x” in version columns can be ambiguous in docs, especially when Nix/flake.lock typically pins exact revisions. Consider either (1) referencing the pinning mechanism explicitly (e.g., ‘pinned by flake.lock / nix-config’) in the table header/notes, or (2) listing concrete versions pulled from the lockfile to keep the documentation verifiable.

Copilot uses AI. Check for mistakes.
README.md Outdated
| Tool | Version | Managed By | Purpose |
|------|---------|------------|---------|
| [kubectl](https://kubernetes.io/) | 1.34.1 | Nix | Kubernetes CLI |
| [kubectl](https://kubernetes.io/) | Latest | Nix | Kubernetes CLI |
Copy link

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

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

Using “Latest”/“x” in version columns can be ambiguous in docs, especially when Nix/flake.lock typically pins exact revisions. Consider either (1) referencing the pinning mechanism explicitly (e.g., ‘pinned by flake.lock / nix-config’) in the table header/notes, or (2) listing concrete versions pulled from the lockfile to keep the documentation verifiable.

Copilot uses AI. Check for mistakes.
- README.md: rename 'Karabiner' to 'Karabiner-Elements' in Stack table,
  fix Oh My Zsh/Powerlevel10k managed-by from 'Nix' to 'Manual (install.sh)',
  add note about Nix flake.lock version pinning, replace ambiguous 'Latest'
  with '-' for Nix-managed tools
- MIGRATION-YABAI-TO-AEROSPACE.md: restore French accents throughout
  (Août, Problèmes, système, nécessite, stabilité, fenêtre, etc.)
- MIGRATION_HOMEBREW.md: update date to Février 2026, fix Nix pkg count
  diagram from 62 to 70+

https://claude.ai/code/session_011v8CcES2CC9k3A7qiF31tG
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.

3 participants