Reconcile README with actual layout#3
Conversation
Document Fish conf.d files, zsh-only helpers, missing ~/.bin on Fish PATH, default prompts, Brewfile split, and ~/.name behavior. Remove inaccurate claims about fish_prompt, cdgr, and Fish dircolors. Co-authored-by: Huy Pham <hdp617@users.noreply.github.com>
There was a problem hiding this comment.
Code Review
This pull request updates the README.md to provide a more detailed and modular breakdown of the repository's layout, specifically detailing the Fish shell configuration snippets, Zsh compatibility, Vim externals, bin scripts, Brewfiles, and local overrides. Feedback was provided to broaden the description of 55-git-prompt.fish to refer to custom prompts in general, as fish_git_prompt can be used in both left and right prompts.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| - **`20-abbreviations.fish`** — cloud/IaC abbreviations, `ls`/`grep` aliases | ||
| - **`40-theme.fish`** — Catppuccin Macchiato via `fish_config theme` | ||
| - **`50-editor-history.fish`** — `EDITOR=vim`, vi key bindings, large history | ||
| - **`55-git-prompt.fish`** — `fish_git_prompt` color/state variables (used when a custom right prompt calls it) |
There was a problem hiding this comment.
The comment states that fish_git_prompt variables are only used when a custom right prompt calls it. However, fish_git_prompt is also used by fish_vcs_prompt, which can be integrated into custom left prompts as well. Consider broadening this description to include any custom prompt (left or right) that utilizes version control status.
| - **`55-git-prompt.fish`** — `fish_git_prompt` color/state variables (used when a custom right prompt calls it) | |
| - **`55-git-prompt.fish`** — `fish_git_prompt` color/state variables (used when a custom prompt calls it) |
Summary
The README described Fish features that do not exist (custom prompts,
cdgr, dircolors) and used the wrong PATH snippet filename. This brings documentation in line with the current repo.Changes
conf.d/inventory andfunctions/list.dot_bin,dot_name.tmpl, Brewfile split, and local override files.dotfiles-local/note.Test plan
dot_config/fish/andshell/aliases.sh