Skip to content

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

Remove double-commenting from project config example (#1836)

Maximilian Roosca5980aee8cd
diff --git a/dev/wt.example.toml b/dev/wt.example.toml
index 5e431b19c..0023950a5 100644
--- a/dev/wt.example.toml
+++ b/dev/wt.example.toml
@@ -1,22 +1,25 @@
# # Project Configuration
#
-# Create with `wt config create --project`.
+# Create with `wt config create --project`. Examples shown — uncomment and customize for your project.
#
# Location: `.config/wt.toml` (checked into version control and shared with the team).
#
# ## Hooks
#
-# See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format:
+# See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format.
+#
+# Single command:
#
-# # Single command
# pre-start = "npm ci"
#
-# # Multiple named commands (concurrent for post-*, sequential for pre-*)
+# Multiple named commands (concurrent for post-*, sequential for pre-*):
+#
# [pre-merge]
# test = "npm test"
# build = "npm run build"
#
-# # Pipeline — list of maps, run in order (each map concurrent)
+# Pipeline — list of maps, run in order (each map concurrent):
+#
# post-start = [
# { install = "npm ci" },
# { build = "npm run build", server = "npm run dev" }
@@ -24,20 +27,23 @@
#
# ## Dev server URL
#
-# # URL column in wt list (dimmed when port not listening)
+# URL column in `wt list` (dimmed when port not listening):
+#
# [list]
# url = "http://localhost:{{ branch | hash_port }}"
#
# ## Forge platform override
#
-# # Override platform detection for SSH aliases or self-hosted instances
+# Override platform detection for SSH aliases or self-hosted instances:
+#
# [forge]
# platform = "github" # or "gitlab"
-# # hostname = "github.example.com" # API host (GHE / self-hosted GitLab)
+# hostname = "github.example.com" # Example: API host (GHE / self-hosted GitLab)
#
# ## Copy-ignored excludes
#
-# # Add more gitignored excludes for wt step copy-ignored
+# Additional excludes for `wt step copy-ignored`:
+#
# [step.copy-ignored]
# exclude = [".cache/", ".turbo/"]
#
diff --git a/docs/content/config.md b/docs/content/config.md
index a995c7783..e1d1bdd11 100644
--- a/docs/content/config.md
+++ b/docs/content/config.md
@@ -340,24 +340,31 @@ squash-template = """
<!-- PROJECT_CONFIG_START -->
# Project Configuration
-Create with `wt config create --project`.
+Create with `wt config create --project`. Examples shown — uncomment and customize for your project.
Location: `.config/wt.toml` (checked into version control and shared with the team).
## Hooks
-See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format:
+See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format.
+
+Single command:
```toml
-# Single command
pre-start = "npm ci"
+```
+
+Multiple named commands (concurrent for post-*, sequential for pre-*):
-# Multiple named commands (concurrent for post-*, sequential for pre-*)
+```toml
[pre-merge]
test = "npm test"
build = "npm run build"
+```
-# Pipeline — list of maps, run in order (each map concurrent)
+Pipeline — list of maps, run in order (each map concurrent):
+
+```toml
post-start = [
{ install = "npm ci" },
{ build = "npm run build", server = "npm run dev" }
@@ -366,25 +373,28 @@ post-start = [
## Dev server URL
+URL column in `wt list` (dimmed when port not listening):
+
```toml
-# URL column in wt list (dimmed when port not listening)
[list]
url = "http://localhost:{{ branch | hash_port }}"
```
## Forge platform override
+Override platform detection for SSH aliases or self-hosted instances:
+
```toml
-# Override platform detection for SSH aliases or self-hosted instances
[forge]
platform = "github" # or "gitlab"
-# hostname = "github.example.com" # API host (GHE / self-hosted GitLab)
+hostname = "github.example.com" # Example: API host (GHE / self-hosted GitLab)
```
## Copy-ignored excludes
+Additional excludes for `wt step copy-ignored`:
+
```toml
-# Add more gitignored excludes for wt step copy-ignored
[step.copy-ignored]
exclude = [".cache/", ".turbo/"]
```
diff --git a/skills/worktrunk/reference/config.md b/skills/worktrunk/reference/config.md
index 9fcbfd1d5..08673dc4d 100644
--- a/skills/worktrunk/reference/config.md
+++ b/skills/worktrunk/reference/config.md
@@ -339,24 +339,31 @@ squash-template = """
<!-- PROJECT_CONFIG_START -->
# Project Configuration
-Create with `wt config create --project`.
+Create with `wt config create --project`. Examples shown — uncomment and customize for your project.
Location: `.config/wt.toml` (checked into version control and shared with the team).
## Hooks
-See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format:
+See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format.
+
+Single command:
```toml
-# Single command
pre-start = "npm ci"
+```
+
+Multiple named commands (concurrent for post-*, sequential for pre-*):
-# Multiple named commands (concurrent for post-*, sequential for pre-*)
+```toml
[pre-merge]
test = "npm test"
build = "npm run build"
+```
-# Pipeline — list of maps, run in order (each map concurrent)
+Pipeline — list of maps, run in order (each map concurrent):
+
+```toml
post-start = [
{ install = "npm ci" },
{ build = "npm run build", server = "npm run dev" }
@@ -365,25 +372,28 @@ post-start = [
## Dev server URL
+URL column in `wt list` (dimmed when port not listening):
+
```toml
-# URL column in wt list (dimmed when port not listening)
[list]
url = "http://localhost:{{ branch | hash_port }}"
```
## Forge platform override
+Override platform detection for SSH aliases or self-hosted instances:
+
```toml
-# Override platform detection for SSH aliases or self-hosted instances
[forge]
platform = "github" # or "gitlab"
-# hostname = "github.example.com" # API host (GHE / self-hosted GitLab)
+hostname = "github.example.com" # Example: API host (GHE / self-hosted GitLab)
```
## Copy-ignored excludes
+Additional excludes for `wt step copy-ignored`:
+
```toml
-# Add more gitignored excludes for wt step copy-ignored
[step.copy-ignored]
exclude = [".cache/", ".turbo/"]
```
diff --git a/src/cli/mod.rs b/src/cli/mod.rs
index 5f7ec20e5..d50127399 100644
--- a/src/cli/mod.rs
+++ b/src/cli/mod.rs
@@ -1916,24 +1916,31 @@ squash-template = """
<!-- PROJECT_CONFIG_START -->
# Project Configuration
-Create with `wt config create --project`.
+Create with `wt config create --project`. Examples shown — uncomment and customize for your project.
Location: `.config/wt.toml` (checked into version control and shared with the team).
## Hooks
-See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format:
+See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format.
+
+Single command:
```toml
-# Single command
pre-start = "npm ci"
+```
+
+Multiple named commands (concurrent for post-*, sequential for pre-*):
-# Multiple named commands (concurrent for post-*, sequential for pre-*)
+```toml
[pre-merge]
test = "npm test"
build = "npm run build"
+```
-# Pipeline — list of maps, run in order (each map concurrent)
+Pipeline — list of maps, run in order (each map concurrent):
+
+```toml
post-start = [
{ install = "npm ci" },
{ build = "npm run build", server = "npm run dev" }
@@ -1942,25 +1949,28 @@ post-start = [
## Dev server URL
+URL column in `wt list` (dimmed when port not listening):
+
```toml
-# URL column in wt list (dimmed when port not listening)
[list]
url = "http://localhost:{{ branch | hash_port }}"
```
## Forge platform override
+Override platform detection for SSH aliases or self-hosted instances:
+
```toml
-# Override platform detection for SSH aliases or self-hosted instances
[forge]
platform = "github" # or "gitlab"
-# hostname = "github.example.com" # API host (GHE / self-hosted GitLab)
+hostname = "github.example.com" # Example: API host (GHE / self-hosted GitLab)
```
## Copy-ignored excludes
+Additional excludes for `wt step copy-ignored`:
+
```toml
-# Add more gitignored excludes for wt step copy-ignored
[step.copy-ignored]
exclude = [".cache/", ".turbo/"]
```
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 7da94c3a5..c5cea439d 100644
--- a/tests/snapshots/integration__integration_tests__help__help_config_create.snap
+++ b/tests/snapshots/integration__integration_tests__help__help_config_create.snap
@@ -304,23 +304,26 @@ With --project, creates .config/wt.toml in the current repositor
  # # Project Configuration
  #
-  # Create with `wt config create --project`.
+  # Create with `wt config create --project`. Examples shown — uncomment and customize for your project.
  #
  # Location: `.config/wt.toml` (checked into version control and shared with the team).
  #
  # ## Hooks
  #
-  # See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format:
+  # See `wt hook --help` for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format.
+  #
+  # Single command:
  #
-  # # Single command
  # pre-start = "npm ci"
  #
-  # # Multiple named commands (concurrent for post-*, sequential for pre-*)
+  # Multiple named commands (concurrent for post-*, sequential for pre-*):
+  #
  # [pre-merge]
  # test = "npm test"
  # build = "npm run build"
  #
-  # # Pipeline — list of maps, run in order (each map concurrent)
+  # Pipeline — list of maps, run in order (each map concurrent):
+  #
  # post-start = [
  # { install = "npm ci" },
  # { build = "npm run build", server = "npm run dev" }
@@ -328,20 +331,23 @@ With --project, creates .config/wt.toml in the current repositor
  #
  # ## Dev server URL
  #
-  # # URL column in wt list (dimmed when port not listening)
+  # URL column in `wt list` (dimmed when port not listening):
+  #
  # [list]
  # url = "http://localhost:{{ branch | hash_port }}"
  #
  # ## Forge platform override
  #
-  # # Override platform detection for SSH aliases or self-hosted instances
+  # Override platform detection for SSH aliases or self-hosted instances:
+  #
  # [forge]
  # platform = "github" # or "gitlab"
-  # # hostname = "github.example.com" # API host (GHE / self-hosted GitLab)
+  # hostname = "github.example.com" # Example: API host (GHE / self-hosted GitLab)
  #
  # ## Copy-ignored excludes
  #
-  # # Add more gitignored excludes for wt step copy-ignored
+  # Additional excludes for `wt step copy-ignored`:
+  #
  # [step.copy-ignored]
  # exclude = [".cache/", ".turbo/"]
  #
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 39adf47b0..9b6d46ba7 100644
--- a/tests/snapshots/integration__integration_tests__help__help_config_long.snap
+++ b/tests/snapshots/integration__integration_tests__help__help_config_long.snap
@@ -341,23 +341,26 @@ Default template:
  """
PROJECT CONFIGURATION
-Create with wt config create --project.
+Create with wt config create --project. Examples shown — uncomment and customize for your project.
Location: .config/wt.toml (checked into version control and shared with the team).
Hooks
-See wt hook --help for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format:
+See wt hook --help for hook types, execution order, template variables, and examples. Both project and user configs support hooks in the same format.
+
+Single command:
-  # Single command
  pre-start = "npm ci"
- 
-  # Multiple named commands (concurrent for post-*, sequential for pre-*)
+
+Multiple named commands (concurrent for post-*, sequential for pre-*):
+
  [pre-merge]
  test = "npm test"
  build = "npm run build"
- 
-  # Pipeline — list of maps, run in order (each map concurrent)
+
+Pipeline — list of maps, run in order (each map concurrent):
+
  post-start = [
   { install = "npm ci" },
   { build = "npm run build", server = "npm run dev" }
@@ -365,20 +368,23 @@ See wt hook --help for hook types, execution order, template variables,
Dev server URL
-  # URL column in wt list (dimmed when port not listening)
+URL column in wt list (dimmed when port not listening):
+
  [list]
  url = "http://localhost:{{ branch | hash_port }}"
Forge platform override
-  # Override platform detection for SSH aliases or self-hosted instances
+Override platform detection for SSH aliases or self-hosted instances:
+
  [forge]
  platform = "github" # or "gitlab"
-  # hostname = "github.example.com" # API host (GHE / self-hosted GitLab)
+  hostname = "github.example.com" # Example: API host (GHE / self-hosted GitLab)
Copy-ignored excludes
-  # Add more gitignored excludes for wt step copy-ignored
+Additional excludes for wt step copy-ignored:
+
  [step.copy-ignored]
  exclude = [".cache/", ".turbo/"]