From 3e00f4e32139d7111768eeb1148560283fbbb571 Mon Sep 17 00:00:00 2001 From: rootiest Date: Mon, 27 Jul 2026 01:02:33 -0400 Subject: [PATCH] docs: rename PATH Setup and format as table Renamed the 'Path Setup' section to 'PATH Setup', formatted the prepended directories list as a Markdown table, and added a NOTE acknowledging that these paths will shadow existing system binaries of the same name. Updated verify-manual.py test since 02-path-setup now contains an Aside and gets correctly promoted to .mdx. --- docs/fish-config.md | 22 +++++++++++++--------- docs/manual/02-path-setup.md | 24 ++++++++++++++---------- docs/verify-manual.py | 6 ++++-- 3 files changed, 31 insertions(+), 21 deletions(-) diff --git a/docs/fish-config.md b/docs/fish-config.md index 85b7028..e547b32 100644 --- a/docs/fish-config.md +++ b/docs/fish-config.md @@ -293,19 +293,23 @@ tab-rename prompt captures. Use `exit --no-log` (or `exit -n`) to skip capture. Directories prepended to PATH in this order (first wins): - ~/.local/bin Standard user-local executables - ~/Applications User-installed standalone apps - ~/scripts Personal shell scripts - ~/bin Cargo binaries (appended — lowest priority) - $BUN_INSTALL/bin Bun runtime and global packages - $NPM_CONFIG_PREFIX/bin Global npm packages - ~/.lmstudio/bin LM Studio CLI - ~/.resend/bin Resend CLI - ~/.fzf/bin fzf binary (git-installed) +| Directory | Purpose | +|---|---| +| `~/.local/bin` | Standard user-local executables | +| `~/Applications` | User-installed standalone apps | +| `~/scripts` | Personal shell scripts | +| `~/bin` | Cargo binaries (appended — lowest priority) | +| `$BUN_INSTALL/bin` | Bun runtime and global packages | +| `$NPM_CONFIG_PREFIX/bin` | Global npm packages | +| `~/.lmstudio/bin` | LM Studio CLI | +| `~/.resend/bin` | Resend CLI | +| `~/.fzf/bin` | `fzf` binary (git-installed) | Cargo binaries are intentionally appended (lowest priority) to avoid shadowing system-installed Rust tools. +NOTE: While these directories are merged with your system's existing `$PATH` values, any executables in the prepended directories above will override (shadow) system binaries of the same name. + --- # 3. KEY BINDINGS diff --git a/docs/manual/02-path-setup.md b/docs/manual/02-path-setup.md index 2c36092..8c9b7e8 100644 --- a/docs/manual/02-path-setup.md +++ b/docs/manual/02-path-setup.md @@ -1,5 +1,5 @@ --- -title: Path Setup +title: PATH Setup manTitle: 2. PATH SETUP sidebar: order: 6 @@ -9,17 +9,21 @@ helpKeywords: Directories prepended to PATH in this order (first wins): - ~/.local/bin Standard user-local executables - ~/Applications User-installed standalone apps - ~/scripts Personal shell scripts - ~/bin Cargo binaries (appended — lowest priority) - $BUN_INSTALL/bin Bun runtime and global packages - $NPM_CONFIG_PREFIX/bin Global npm packages - ~/.lmstudio/bin LM Studio CLI - ~/.resend/bin Resend CLI - ~/.fzf/bin fzf binary (git-installed) +| Directory | Purpose | +|---|---| +| `~/.local/bin` | Standard user-local executables | +| `~/Applications` | User-installed standalone apps | +| `~/scripts` | Personal shell scripts | +| `~/bin` | Cargo binaries (appended — lowest priority) | +| `$BUN_INSTALL/bin` | Bun runtime and global packages | +| `$NPM_CONFIG_PREFIX/bin` | Global npm packages | +| `~/.lmstudio/bin` | LM Studio CLI | +| `~/.resend/bin` | Resend CLI | +| `~/.fzf/bin` | `fzf` binary (git-installed) | Cargo binaries are intentionally appended (lowest priority) to avoid shadowing system-installed Rust tools. +NOTE: While these directories are merged with your system's existing `$PATH` values, any executables in the prepended directories above will override (shadow) system binaries of the same name. + --- diff --git a/docs/verify-manual.py b/docs/verify-manual.py index 372d910..47409dc 100644 --- a/docs/verify-manual.py +++ b/docs/verify-manual.py @@ -718,8 +718,10 @@ def test_site_promotes_pages_with_asides_or_filetrees_to_mdx(): assert (out / "07-customization.mdx").exists(), "Aside page (rewritten NOTE) was not promoted to .mdx" - assert (out / "02-path-setup.md").exists(), "plain page was wrongly promoted to .mdx" - assert not (out / "02-path-setup.mdx").exists(), "plain page should stay .md" + assert (out / "02-path-setup.mdx").exists(), "Aside page (NOTE) was not promoted to .mdx" + + assert (out / "03-key-bindings.md").exists(), "plain page was wrongly promoted to .mdx" + assert not (out / "03-key-bindings.mdx").exists(), "plain page should stay .md" text = (out / "10-personalization.mdx").read_text() assert "FileTree" in text.split("from '@astrojs/starlight/components';")[0]