Skip to content

Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows

docs(help): rename '[Aliases]' link to 'Extending Worktrunk guide' (#2330)

Maximilian Roos86f4b37e4837
diff --git a/CLAUDE.md b/CLAUDE.md
index 70af7aafe..695c69b6c 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -144,6 +144,8 @@ Help text renders in three contexts — check all three when editing:
Because web docs concatenate everything, the `after_long_help` opener must not restate the `about`/`subtitle`. Start with new information — examples, context, or details not already in the definition. See `docs/CLAUDE.md` → "Command documentation structure" for detailed content principles and good/bad opener patterns.
+Link text must stand alone when the URL is stripped (terminal help drops the URL and keeps only the text). Use `` [`wt foo`](...) `` for commands — the backticks signal a `--help` lookup — or a descriptive phrase (`[hook template variables]`, `[Extending Worktrunk guide]`) for doc sections. Avoid bare labels that match the destination's heading (e.g., `See [Aliases](@/extending.md#aliases)` reads as a self-reference in terminal).
+
After any doc changes, run tests to sync:
```bash
diff --git a/dev/config.example.toml b/dev/config.example.toml
index 25a3ec075..18ddd7b36 100644
--- a/dev/config.example.toml
+++ b/dev/config.example.toml
@@ -127,7 +127,7 @@
#
# ### Aliases
#
-# Command templates that run as `wt <name>`. See Aliases (https://worktrunk.dev/extending/#aliases) for usage and flags.
+# Command templates that run as `wt <name>`. See the Extending Worktrunk guide (https://worktrunk.dev/extending/#aliases) for usage and flags.
#
# [aliases]
# greet = "echo Hello from {{ branch }}"
diff --git a/dev/wt.example.toml b/dev/wt.example.toml
index 831b76357..f802e09c1 100644
--- a/dev/wt.example.toml
+++ b/dev/wt.example.toml
@@ -38,7 +38,7 @@
#
# ## Aliases
#
-# Command templates that run as `wt <name>`. See Aliases (https://worktrunk.dev/extending/#aliases) for usage and flags.
+# Command templates that run as `wt <name>`. See the Extending Worktrunk guide (https://worktrunk.dev/extending/#aliases) for usage and flags.
#
# [aliases]
# deploy = "make deploy BRANCH={{ branch }}"
diff --git a/docs/content/config.md b/docs/content/config.md
index 6dba6163b..3bef9f6d2 100644
--- a/docs/content/config.md
+++ b/docs/content/config.md
@@ -219,7 +219,7 @@ Built-in excludes always apply: VCS metadata directories (`.bzr/`, `.hg/`, `.jj/
### Aliases
-Command templates that run as `wt <name>`. See [Aliases](@/extending.md#aliases) for usage and flags.
+Command templates that run as `wt <name>`. See the [Extending Worktrunk guide](@/extending.md#aliases) for usage and flags.
```toml
[aliases]
@@ -396,7 +396,7 @@ Built-in excludes always apply: VCS metadata directories (`.bzr/`, `.hg/`, `.jj/
## Aliases
-Command templates that run as `wt <name>`. See [Aliases](@/extending.md#aliases) for usage and flags.
+Command templates that run as `wt <name>`. See the [Extending Worktrunk guide](@/extending.md#aliases) for usage and flags.
```toml
[aliases]
@@ -617,7 +617,7 @@ Usage: <b><span class=c>wt config approvals</span></b> <span class=c>[OPTIONS]</
Inspect and preview aliases.
-Aliases are command templates configured in user (`~/.config/worktrunk/config.toml`) or project (`.config/wt.toml`) config and run as `wt <name>`. See [Aliases](@/extending.md#aliases) for the configuration format.
+Aliases are command templates configured in user (`~/.config/worktrunk/config.toml`) or project (`.config/wt.toml`) config and run as `wt <name>`. See the [Extending Worktrunk guide](@/extending.md#aliases) for the configuration format.
### Examples
diff --git a/skills/worktrunk/reference/config.md b/skills/worktrunk/reference/config.md
index 5ed8c2a41..d2c57624c 100644
--- a/skills/worktrunk/reference/config.md
+++ b/skills/worktrunk/reference/config.md
@@ -218,7 +218,7 @@ Built-in excludes always apply: VCS metadata directories (`.bzr/`, `.hg/`, `.jj/
### Aliases
-Command templates that run as `wt <name>`. See [Aliases](https://worktrunk.dev/extending/#aliases) for usage and flags.
+Command templates that run as `wt <name>`. See the [Extending Worktrunk guide](https://worktrunk.dev/extending/#aliases) for usage and flags.
```toml
[aliases]
@@ -395,7 +395,7 @@ Built-in excludes always apply: VCS metadata directories (`.bzr/`, `.hg/`, `.jj/
## Aliases
-Command templates that run as `wt <name>`. See [Aliases](https://worktrunk.dev/extending/#aliases) for usage and flags.
+Command templates that run as `wt <name>`. See the [Extending Worktrunk guide](https://worktrunk.dev/extending/#aliases) for usage and flags.
```toml
[aliases]
@@ -628,7 +628,7 @@ Global Options:
Inspect and preview aliases.
-Aliases are command templates configured in user (`~/.config/worktrunk/config.toml`) or project (`.config/wt.toml`) config and run as `wt <name>`. See [Aliases](https://worktrunk.dev/extending/#aliases) for the configuration format.
+Aliases are command templates configured in user (`~/.config/worktrunk/config.toml`) or project (`.config/wt.toml`) config and run as `wt <name>`. See the [Extending Worktrunk guide](https://worktrunk.dev/extending/#aliases) for the configuration format.
### Examples
diff --git a/src/cli/config.rs b/src/cli/config.rs
index 73ebe52c4..aab9c749a 100644
--- a/src/cli/config.rs
+++ b/src/cli/config.rs
@@ -487,7 +487,7 @@ Approved commands are saved to `~/.config/worktrunk/approvals.toml`. Re-approval
/// Inspect and preview aliases
#[command(
- after_long_help = r#"Aliases are command templates configured in user (`~/.config/worktrunk/config.toml`) or project (`.config/wt.toml`) config and run as `wt <name>`. See [Aliases](@/extending.md#aliases) for the configuration format.
+ after_long_help = r#"Aliases are command templates configured in user (`~/.config/worktrunk/config.toml`) or project (`.config/wt.toml`) config and run as `wt <name>`. See the [Extending Worktrunk guide](@/extending.md#aliases) for the configuration format.
## Examples
diff --git a/src/cli/mod.rs b/src/cli/mod.rs
index bf1c7390d..ec7d19f52 100644
--- a/src/cli/mod.rs
+++ b/src/cli/mod.rs
@@ -1643,7 +1643,7 @@ Built-in excludes always apply: VCS metadata directories (`.bzr/`, `.hg/`, `.jj/
### Aliases
-Command templates that run as `wt <name>`. See [Aliases](@/extending.md#aliases) for usage and flags.
+Command templates that run as `wt <name>`. See the [Extending Worktrunk guide](@/extending.md#aliases) for usage and flags.
```toml
[aliases]
@@ -1820,7 +1820,7 @@ Built-in excludes always apply: VCS metadata directories (`.bzr/`, `.hg/`, `.jj/
## Aliases
-Command templates that run as `wt <name>`. See [Aliases](@/extending.md#aliases) for usage and flags.
+Command templates that run as `wt <name>`. See the [Extending Worktrunk guide](@/extending.md#aliases) for usage and flags.
```toml
[aliases]
diff --git a/tests/snapshots/integration__integration_tests__help__help_config_create.snap b/tests/snapshots/integration__integration_tests__help__help_config_create.snap
index dc0ccedb7..d29419c0e 100644
--- a/tests/snapshots/integration__integration_tests__help__help_config_create.snap
+++ b/tests/snapshots/integration__integration_tests__help__help_config_create.snap
@@ -188,7 +188,7 @@ Creates ~/.config/worktrunk/config.toml with the following content:
  #
  # ### Aliases
  #
-  # Command templates that run as `wt <name>`. See Aliases (https://worktrunk.dev/extending/#aliases) for usage and flags.
+  # Command templates that run as `wt <name>`. See the Extending Worktrunk guide (https://worktrunk.dev/extending/#aliases) for usage and flags.
  #
  # [aliases]
  # greet = "echo Hello from {{ branch }}"
@@ -352,7 +352,7 @@ With --project, creates .config/wt.toml in the current repositor
  #
  # ## Aliases
  #
-  # Command templates that run as `wt <name>`. See Aliases (https://worktrunk.dev/extending/#aliases) for usage and flags.
+  # Command templates that run as `wt <name>`. See the Extending Worktrunk guide (https://worktrunk.dev/extending/#aliases) for usage and flags.
  #
  # [aliases]
  # deploy = "make deploy BRANCH={{ branch }}"
diff --git a/tests/snapshots/integration__integration_tests__help__help_config_long.snap b/tests/snapshots/integration__integration_tests__help__help_config_long.snap
index 690bf2c1e..656769939 100644
--- a/tests/snapshots/integration__integration_tests__help__help_config_long.snap
+++ b/tests/snapshots/integration__integration_tests__help__help_config_long.snap
@@ -236,7 +236,7 @@ Built-in excludes always apply: VCS metadata directories (.bzr/, .hg
Aliases
-Command templates that run as wt <name>. See Aliases for usage and flags.
+Command templates that run as wt <name>. See the Extending Worktrunk guide for usage and flags.
  [aliases]
  greet = "echo Hello from {{ branch }}"
@@ -391,7 +391,7 @@ Built-in excludes always apply: VCS metadata directories (.bzr/, .hg
Aliases
-Command templates that run as wt <name>. See Aliases for usage and flags.
+Command templates that run as wt <name>. See the Extending Worktrunk guide for usage and flags.
  [aliases]
  deploy = "make deploy BRANCH={{ branch }}"