Skip to content

docs: update features and how it works#17

Merged
raisedadead merged 1 commit intomainfrom
claude/polish-readme-wGPzr
Feb 23, 2026
Merged

docs: update features and how it works#17
raisedadead merged 1 commit intomainfrom
claude/polish-readme-wGPzr

Conversation

@raisedadead
Copy link
Owner

Summary

This is a comprehensive restructuring and expansion of the README to improve clarity, organization, and user guidance. The changes reorganize content into logical sections with better visual hierarchy and add more detailed explanations of features, workflows, and configuration options.

Key Changes

  • Improved introduction: Clarified the dual CLI/TUI nature and core value proposition in the opening paragraphs
  • Enhanced "Why worktrees?" section: Replaced table format with narrative explanation and ASCII diagram showing the directory structure
  • Reorganized commands section: Split into separate tables for main commands, workflows, and common flags with clearer descriptions
  • New dedicated sections:
    • Terminal UI — detailed keybindings and feature overview
    • Workflows — comprehensive table of workflow flags with branch templates and descriptions
    • Configuration — hierarchical config explanation with example TOML
    • Hooks — new dedicated section covering bundled hooks, setup, management, and custom hooks
    • Shell completions — moved to prominent section with setup instructions
    • JSON output — new section documenting machine-readable output format
  • Improved documentation links: Reorganized and clarified cross-references to docs
  • Development section: Simplified and moved to end with clearer command descriptions
  • Formatting improvements:
    • Consistent use of em-dashes instead of hyphens
    • Better visual separation between sections
    • Improved code block formatting
    • Clearer emphasis on optional vs required components

Notable Details

  • Added practical examples throughout (e.g., wt add --bugfix --issue 42)
  • Expanded hook system documentation with environment variables and protocol reference
  • Clarified configuration hierarchy and precedence
  • Added JSON output envelope example for scripting use cases
  • Improved navigation guidance (e.g., TUI keybindings, shell wrapper behavior)

https://claude.ai/code/session_01QoLnj9wswsduNCCcCoowhU

Restructure and rewrite the README to better showcase wt's features:

- Reframe the intro around the problem worktrees solve
- Add dedicated sections for TUI, workflows, hooks, JSON output,
  and shell completions
- Document the git-wt subcommand and Homebrew auto-completions
- Consolidate flags into a single reference table
- Improve code examples with realistic output (issue titles, etc.)
- Tighten prose throughout for scannability

https://claude.ai/code/session_01QoLnj9wswsduNCCcCoowhU
@raisedadead raisedadead enabled auto-merge (squash) February 23, 2026 16:01
@raisedadead raisedadead changed the title Restructure and expand README with improved organization docs: update features and how it works Feb 23, 2026
@raisedadead raisedadead merged commit d170760 into main Feb 23, 2026
3 checks passed
@raisedadead raisedadead deleted the claude/polish-readme-wGPzr branch February 23, 2026 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants