Skip to content

Reconcile README with actual layout#3

Draft
hdp617 wants to merge 1 commit into
mainfrom
cursor/reconcile-readme-bb31
Draft

Reconcile README with actual layout#3
hdp617 wants to merge 1 commit into
mainfrom
cursor/reconcile-readme-bb31

Conversation

@hdp617

@hdp617 hdp617 commented Jul 9, 2026

Copy link
Copy Markdown
Owner

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

  • Expand Layout notes with accurate Fish conf.d/ inventory and functions/ list.
  • Clarify zsh-only helpers, default Fish prompts, and nord dircolors scope.
  • Document dot_bin, dot_name.tmpl, Brewfile split, and local override files.
  • Remove stale dotfiles-local/ note.

Test plan

  • Read-through for accuracy against dot_config/fish/ and shell/aliases.sh
Open in Web Open in Cursor 

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>

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Comment thread README.md
- **`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)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

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.

Suggested change
- **`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)

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.

2 participants