Skip to content

docs: improve readability in Features section #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
satococoa merged 3 commits into from
Feb 27, 2026
Merged

docs: improve readability in Features section #87

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c823d44
docs: add line breaks before wtp solution labels
satococoa Feb 11, 2026
6b31575
docs: force rendered line break before solution labels
satococoa Feb 11, 2026
2f0f098
docs: use problem and wtp labels in features
satococoa Feb 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ functionality with automated setup, branch tracking, and project-specific hooks.
### 🚀 No More Path Gymnastics

**git-worktree pain:**
`git worktree add ../project-worktrees/feature/auth feature/auth` **wtp
solution:** `wtp add feature/auth`
`git worktree add ../project-worktrees/feature/auth feature/auth`<br>
**wtp solution:** `wtp add feature/auth`
Copy link

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

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

In GitHub-flavored Markdown, a single newline inside a paragraph is rendered as a space. As written, this likely won’t create a visible line break between the command and the “wtp solution” label. To ensure the intended separation, add a blank line between them or use a hard line break (two trailing spaces or <br>).

Copilot uses AI. Check for mistakes.

wtp automatically generates sensible paths based on branch names. Your
`feature/auth` branch goes to `../worktrees/feature/auth` - no redundant typing,
Expand All @@ -18,7 +18,8 @@ no path errors.
### 🧹 Clean Branch Management

**git-worktree pain:** Remove worktree, then manually delete the branch. Forget
the second step? Orphaned branches accumulate. **wtp solution:**
the second step? Orphaned branches accumulate.<br>
Copy link

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

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

This “wtp solution” line is preceded by a normal newline, which Markdown typically collapses into a space; the label may still appear on the same rendered line as the preceding sentence. Insert a blank line before the label or use a hard line break so the readability improvement actually shows up in the rendered README.

Suggested change
the second step? Orphaned branches accumulate.<br>
the second step? Orphaned branches accumulate.<br>

Copilot uses AI. Check for mistakes.
**wtp solution:**
`wtp remove --with-branch feature/done` - One command removes both

Keep your repository clean. When a feature is truly done, remove both the
Expand All @@ -28,7 +29,8 @@ cluttering your repo.
### 🛠️ Zero-Setup Development Environments

**git-worktree pain:** Create worktree → Copy .env → Install deps → Run
migrations → Finally start coding **wtp solution:** Configure once in
migrations → Finally start coding<br>
Copy link

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

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

The newline before this “wtp solution” label may not render as a line break in Markdown (it’s treated as whitespace within the same paragraph). If the goal is visual separation, add a blank line before the label or use a hard line break.

Suggested change
migrations → Finally start coding<br>
migrations → Finally start coding<br>

Copilot uses AI. Check for mistakes.
**wtp solution:** Configure once in
`.wtp.yml`, then every `wtp add` runs your setup automatically

```yaml
Expand Down Expand Up @@ -60,7 +62,8 @@ requirements.
### 📍 Instant Worktree Navigation

**git-worktree pain:** `cd ../../../worktrees/feature/auth` (if you remember the
path) **wtp solution:** `wtp cd feature/auth` with tab completion
path)<br>
Copy link

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

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

Markdown will usually collapse the newline before this label into a space, so the “wtp solution” text may still render inline with the preceding line. Add a blank line or a hard line break to reliably force the visual separation.

Suggested change
path)<br>
path)<br>

Copilot uses AI. Check for mistakes.
**wtp solution:** `wtp cd feature/auth` with tab completion

Jump between worktrees instantly. Use `wtp cd @` to return to your main
worktree (or just `wtp cd`). No more terminal tab confusion.
Expand Down
Loading