Skip to content

Commit f3edd84

Browse files
committed
chore(readme): link referenced repo files
Convert plain file mentions in the README to clickable links and add MCP servers docs to Further reading. Made-with: Cursor
1 parent 9414a28 commit f3edd84

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -110,11 +110,11 @@ chezmoi is configured to use Bitwarden CLI (`bw`) as its secret manager. Some te
110110

111111
### Template flags
112112

113-
chezmoi uses two boolean flags to adapt behavior per machine. Both are set automatically in `.chezmoi.toml.tmpl`.
113+
chezmoi uses two boolean flags to adapt behavior per machine. Both are set automatically in [`home/.chezmoi.toml.tmpl`](home/.chezmoi.toml.tmpl).
114114

115115
| Flag | When true | What it gates |
116116
|--------------|---------------------------------|---------------------------------------------------------------------------------------------------------------|
117-
| `codespaces` | `CODESPACES` env var is set | Skips GUI apps and redundant packages in the Brewfile. Uses the overlay fast path in `install.sh`. |
117+
| `codespaces` | `CODESPACES` env var is set | Skips GUI apps and redundant packages in the Brewfile. Uses the overlay fast path in [`install.sh`](install.sh). |
118118
| `private` | Windows, or `~/.private` exists | Enables personal-machine config: excludes work-specific MCP servers and Atlassian integrations from OpenCode. |
119119

120120
> [!IMPORTANT]
@@ -153,13 +153,13 @@ This repo ships a pre-baked [overlay container image](https://ghcr.io/chipwolf/d
153153

154154
If you fork this repo, the main things to update:
155155

156-
1. **`home/Brewfile`**: adjust packages to taste.
157-
2. **Git identity**: update `home/dot_gitconfig` with your name, email, and signing key.
156+
1. **[`home/Brewfile`](home/Brewfile)**: adjust packages to taste.
157+
2. **Git identity**: update [`home/dot_gitconfig`](home/dot_gitconfig) with your name, email, and signing key.
158158

159-
The install scripts (`install.sh`, `install.ps1`) have the repo URL interpolated automatically during the release workflow, so forks that use the same workflow get correct URLs in their release assets without editing.
159+
The install scripts ([`install.sh`](install.sh), [`install.ps1`](install.ps1)) have the repo URL interpolated automatically during the release workflow, so forks that use the same workflow get correct URLs in their release assets without editing.
160160

161161
> [!TIP]
162-
> The chezmoi source state lives under `home/` (set by `.chezmoiroot`). Filenames use chezmoi's attribute prefixes: `dot_` becomes a leading `.`, `private_` restricts permissions, `executable_` adds the execute bit. `home/dot_config/nvim/` deploys to `~/.config/nvim/`.
162+
> The chezmoi source state lives under [`home/`](home/) (set by [`.chezmoiroot`](.chezmoiroot)). Filenames use chezmoi's attribute prefixes: `dot_` becomes a leading `.`, `private_` restricts permissions, `executable_` adds the execute bit. [`home/dot_config/nvim/`](home/dot_config/nvim/) deploys to `~/.config/nvim/`.
163163
164164
---
165165

@@ -183,7 +183,7 @@ All release artifacts are built with [SLSA Build L3](https://slsa.dev/spec/v1.0/
183183

184184
This covers:
185185

186-
- **Install scripts** (`install.sh`, `install.ps1`): published as [GitHub Release](https://github.com/chipwolf/dotfiles/releases/tag/v1.6.0) assets. <!-- x-release-please-version -->
186+
- **Install scripts** ([`install.sh`](install.sh), [`install.ps1`](install.ps1)): published as [GitHub Release](https://github.com/chipwolf/dotfiles/releases/tag/v1.6.0) assets. <!-- x-release-please-version -->
187187
- **Codespaces overlay image** ([ghcr.io/chipwolf/dotfiles](https://ghcr.io/chipwolf/dotfiles)): published to GHCR.
188188

189189
> [!NOTE]
@@ -210,5 +210,6 @@ gh attestation verify oci://ghcr.io/chipwolf/dotfiles:v1.6.0 --repo chipwolf/dot
210210
| Document | Contents |
211211
|------------------------------------|----------------------------------------------------------------|
212212
| [docs/brew-review.md](docs/brew-review.md) | Homebrew drift review flow, prompts, and safe tap handling |
213+
| [docs/mcp-servers.md](docs/mcp-servers.md) | MCP server setup, conditions, targets, and arg interpolation |
213214
| [docs/yubikey.md](docs/yubikey.md) | YubiKey SSH workflow, backup strategy, credential hygiene |
214215
| [docs/secrets.md](docs/secrets.md) | Bitwarden integration, GnuPG config, secret introduction order |

0 commit comments

Comments
 (0)