Commit Graph

1003 Commits

Author SHA1 Message Date
Maximilian Roos 19289527fe Enhance docs UI with interactive hover effects and visual polish
Add animated underlines to footer and nav links, heading anchor reveal
on hover, code block glow effect, and text selection styling. Include
subtle background grain texture and gentle bounce animation for explore
button. Improves visual feedback and interactivity across documentation.
2025-12-02 23:03:14 -08:00
Maximilian Roos 0ecb939217 Simplify LLM commit docs to focus on practical usage
Reorganizes content to prioritize how-to information over technical implementation details. Removes the "two generation modes" section and replaces it with a streamlined "How it works" overview. Consolidates template variable documentation, updates command examples, and clarifies when each command generates messages. Also includes `wt step squash` in the integration list.
2025-12-02 23:02:02 -08:00
Maximilian Roos 0db5dec2d2 Change path mismatch symbol from ⚐ to ⚑ and apply red styling
Updated the WorktreeState::PathMismatch indicator to use a red flag (⚑) instead of white flag (⚐), better conveying the severity of a path location error. Applied red color styling to distinguish this condition from other worktree warnings (prunable, locked) which remain yellow.

Updated documentation and test snapshots to reflect the new symbol and color scheme.
2025-12-02 23:00:25 -08:00
Maximilian Roos 0a8103250c Add view transitions for smooth page navigation
Enable View Transitions API for same-origin navigation with 50ms animation duration. Add instant.page for prefetching to improve perceived performance. Respect prefers-reduced-motion by disabling transition animations for users who prefer reduced motion.
2025-12-02 22:58:12 -08:00
Maximilian Roos 1717529783 Add copy-to-clipboard button for code blocks
Implements a floating copy button that appears on code block hover, with special handling to strip shell prompts from terminal blocks before copying.

New files:
- code-copy.js: Attaches copy buttons to all code blocks, strips leading `$ ` from bash/shell/terminal blocks, shows checkmark feedback for 2 seconds after successful copy

Style updates:
- .code-copy-btn: Positioned absolutely in top-right, hidden by default with opacity transition, styled to match design system colors
- .content pre:hover .code-copy-btn: Reveals button on code block hover
- Button includes copied state with accent color highlight
2025-12-02 22:55:32 -08:00
Maximilian Roos 57f7691f53 Refine micro-interactions and remove layout shifts
Remove font-weight change from active TOC items and button lift effect to prevent layout shifts. Add polished micro-interactions: animated link underlines, enhanced button shadows, search focus glow, and custom scrollbar styling for better visual feedback.
2025-12-02 22:30:54 -08:00
Maximilian Roos 7bc0bcdbd8 Replace GitHub button widget with shield badge
Remove async GitHub buttons script and replace the dynamic button with a static shield.io badge. This eliminates external script dependency and provides a lighter-weight alternative.
2025-12-02 22:26:38 -08:00
Maximilian Roos 0619ef8ffb Consolidate intro content into quickstart for streamlined onboarding
Remove separate intro page and merge its content into quickstart as the
primary entry point. Reorder documentation weights so quickstart appears
first, followed by concepts. Remove "Worktree addressing" section from
concepts as it duplicates information covered elsewhere. Update homepage
to display quickstart content directly instead of intro.
2025-12-02 22:25:09 -08:00
Maximilian Roos c691004b02 Remove bash syntax highlighting from command reference blocks
Command output blocks don't require language specification and render
correctly without it. Removing `bash` from the markdown fence makes
the markup cleaner and more semantically accurate.
2025-12-02 21:20:56 -08:00
Maximilian Roos acf564f5ff Enhance docs design with refined code blocks, typography, and hero section
Code blocks now feature a distinctive left accent border with subtle shadows
and hover effects for better visual hierarchy. Terminal output styling updated
with improved line-height calculations and gutter spacing.

Typography improved by adding Inter and Plus Jakarta Sans fonts for better
readability and visual distinction between body and heading text.

Hero section enhanced with warm radial gradient background, glowing logo effect
with hover animation, and floating "explore more" button animation. Dark mode
adjustments ensure consistent visual experience across color schemes.
2025-12-02 21:13:25 -08:00
Maximilian Roos 6f0bee5bf6 Optimize logo loading and improve image performance
Add responsive logo preloading with device pixel ratio media queries to serve high-DPI variants on appropriate devices. Include preload directives for syntax highlighting stylesheets and custom CSS to reduce render-blocking. Add explicit dimensions, decoding hints, and fetchpriority attributes to logo images for better perceived performance and Core Web Vitals.
2025-12-02 21:09:54 -08:00
Maximilian Roos 039616938e Refactor command docs for clarity and consistency
Update help text and documentation across all commands to improve clarity:

- Simplify introductory descriptions to focus on what commands do, not why
- Reorganize status symbol tables into logical groups (working tree, branch, divergence, remote, other)
- Consolidate column descriptions for better readability
- Rewrite sections to use active voice and concrete language
- Add "See Also" cross-references to related commands
- Streamline examples to be more concise with inline comments
- Improve JSON query examples with shorter descriptions
- Clarify hook behavior descriptions without assuming user intent
- Update help snapshots to reflect documentation changes
2025-12-02 21:08:35 -08:00
Maximilian Roos 37324ced27 Refine TOC spacing and specificity for improved readability
Wrap TOC selectors in `main` to override juice.scss specificity and adjust
spacing values across group labels, items, and nested items for tighter,
more consistent visual hierarchy. Increases top margin for group labels to
create clearer section breaks while reducing horizontal margins and padding
for compact layout.
2025-12-02 20:59:17 -08:00
Maximilian Roos 4928e7ad4b Tighten typography spacing and reduce padding in docs
Adjusts line-height, heading margins, and content padding for more compact
visual hierarchy. Reduces paragraph bottom margin and list item padding to
decrease overall vertical whitespace.
2025-12-02 20:35:12 -08:00
Maximilian Roos 8e6c34dd1c Document environment variable config overrides
Add comprehensive guide on how to override config options via environment variables with the `WORKTRUNK_` prefix. Includes naming conventions, nested key syntax with double underscores, array value handling, and CI/testing examples. Updates both user-config reference and main configuration docs.
2025-12-02 20:09:42 -08:00
Maximilian Roos f80d87b229 docs: refactor command pages for consistency and auto-sync
Reorganize command documentation (switch, list, merge, remove, select, config, step)
for consistency and clarity. Restructure around user tasks: intro, examples, features,
then technical details. Update CLAUDE.md with documentation guidelines.

Add `test_command_pages_are_in_sync()` integration test to auto-update command pages
when `wt <cmd> --help-page` output changes, eliminating manual regeneration.

Update docs/CLAUDE.md to document the new sync test workflow instead of manual
regeneration steps.
2025-12-02 19:20:01 -08:00
Maximilian Roos b5527a1907 Docs: Revamp config documentation
This change reorganizes the configuration documentation for clarity.

It now clearly separates user config (personal settings) from project config (shared hooks), provides detailed examples for each setting, and uses tables for improved readability.
2025-12-02 18:59:23 -08:00
Maximilian Roos c846d225ec Refactor wt switch docs for clarity 2025-12-02 18:27:33 -08:00
Maximilian Roos db0e998e3d Docs: Add explanation of command documentation generation 2025-12-02 18:26:18 -08:00
Maximilian Roos 5c6273dd7e Docs: Limit TOC to H2 for improved readability 2025-12-02 18:13:54 -08:00
Maximilian Roos eb32114a08 Docs: Split command pages with --help-page generation
Add dedicated documentation pages for each command (switch, list, merge,
remove, select, config, step) generated from CLI help text via new
--help-page flag. Pages include prose documentation from after_long_help
and command reference at bottom.

- Add --help-page flag to main.rs for generating doc pages
- Create individual command pages with Zola frontmatter
- Add sidebar grouping (Commands/Reference) via page.extra.group
- Update page.html template to render group labels
- Delete monolithic commands.md in favor of individual pages
- Tighten TOC spacing for child items

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-02 17:24:52 -08:00
Maximilian Roos 3f81f285ac Docs: Split command pages with --help-page generation
Add dedicated documentation pages for each command (switch, list, merge,
remove, select, config, step) generated from CLI help text via new
--help-page flag. Pages include prose documentation from after_long_help
and command reference at bottom.

- Add --help-page flag to main.rs for generating doc pages
- Create individual command pages with Zola frontmatter
- Add sidebar grouping (Commands/Reference) via page.extra.group
- Update page.html template to render group labels
- Delete monolithic commands.md in favor of individual pages
- Tighten TOC spacing for child items

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-02 16:29:22 -08:00
Maximilian Roos a0b9a21be0 Docs: Implement dark mode for improved user experience 2025-12-02 16:17:46 -08:00
Maximilian Roos 051207d86d Docs: Emphasize visual review for accuracy
Adds a new section on the importance of visual verification for docs changes. This ensures rendered output matches expectations and avoids common display issues related to CSS and templates.
2025-12-02 14:29:55 -08:00
Maximilian Roos 9922b91583 Docs: Improve table formatting and readability
This commit updates the styling of tables in the documentation to enhance their visual appeal and make them easier to read.

Changes include:
- Reduced padding for `th` and `td` elements.
- Added `vertical-align: top` to table cells.
- Standardized `th` styles for better differentiation.
- Increased `td` font size.
- Highlighted first column `td` elements as row labels.
- Replaced zebra striping with row dividers for a cleaner look.
- Removed bold styling from the first column in the "Why git worktrees?" table.
2025-12-02 14:28:15 -08:00
Maximilian Roos de215dead5 Docs: Add terminal output gutter styling
Adds a new CSS variable for a subtle bright white color, and styles
gutter spans in the terminal output to form continuous vertical lines.
The line-height in the terminal class is also adjusted to allow
proper calculation of the gutter span's vertical margin and padding.
2025-12-02 14:26:00 -08:00
Maximilian Roos d158d77887 Docs: Remind to include dev server link in response 2025-12-02 14:24:52 -08:00
Maximilian Roos e017c3640c Update auto-generated commands.md 2025-12-02 14:23:35 -08:00
Maximilian Roos a5184aa17d Feat: Add logo generation script and update docs
This commit introduces a new script `dev/generate-logo.sh` along with its prompt `dev/logo-prompt.json` to create logo variants.

It updates the documentation to:
- Reference the new PNG logo files instead of the old SVG.
- Include `logo-variant-*.png` in the `.gitignore`.
- Update the favicon to use the new logo's style.
- Adjust CSS for logo display and hero image.
2025-12-02 14:20:27 -08:00
Maximilian Roos b2c3d70f51 Docs: Add client-side search functionality
Adds an in-docs search bar, using elasticlunr with Zola's built-in search index. Search results are displayed as an in-page dropdown.
2025-12-02 12:45:16 -08:00
Maximilian Roos 303b88d636 Docs: Create dedicated page for LLM commits 2025-12-02 12:22:41 -08:00
Maximilian Roos cb9afed8b4 Docs: Tighten content spacing
- Reduce top and bottom margin on H2, H3 headings.
- Reduce top and bottom margin on code blocks, blockquotes, and tables.
- Add specific CSS to reduce space between paragraphs and code blocks.
2025-12-02 11:58:38 -08:00
Maximilian Roos 0042a245f3 Docs: Add details for development workflow
Adds instructions for starting the dev server and a note about
keeping it running for user review.
2025-12-02 10:14:36 -08:00
Maximilian Roos 0f101f27f6 Docs: Add dedicated Hooks page
Move configuration for project hooks to a new dedicated page. This improves organization and expands on hook details and examples.

The existing Configuration page now links to the new Hooks page.
Weight values for several documentation pages are adjusted to maintain order.
2025-12-02 10:03:32 -08:00
Maximilian Roos 131a7bc7bc Regenerate help-md output
Auto-generated files restored to canonical --help-md format.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-01 23:18:19 -08:00
Maximilian Roos e5c8c7e397 Docs: standardize console output to bash
Standardizes code blocks using `console` to `bash` in the documentation.
2025-12-01 23:15:44 -08:00
Maximilian Roos 7029e8df8b Add box-sizing: border-box to sticky TOC
This ensures padding and border are included in `max-height` calculation.
2025-12-01 22:08:17 -08:00
Maximilian Roos d7a68904d2 Docs: Improve code block highlighting
This commit enhances the code block highlighting within the documentation for improved readability and user experience.
2025-12-01 21:20:52 -08:00
Maximilian Roos a1f09cf5c0 docs: Adjust help output heading levels
Increase markdown heading levels in auto-generated help content
so that they become children of the command's main heading.
2025-12-01 21:19:25 -08:00
Maximilian Roos b1c0be7415 Add intro page to documentation
- The `intro` page provides a high-level overview of Worktrunk.
- The homepage now displays the content of the `intro` page.
- Renames `quickstart` to `intro` in the navigation.
- Updates page weights to accommodate the new `intro` page.
- Updates snapshot sync for doc files.
2025-12-01 21:07:40 -08:00
Maximilian Roos 4df03afe1a Customize Juice theme header and navigation
The default Juice header includes the full navigation menu in the
header, which is already present in the sidebar. This commit
customizes the header to only include a logo and a simplified
menu with "Get Started", "Tips", and "GitHub" links.

Also removes `juice_exclude_menu` since we are manually defining
the header.
2025-12-01 21:06:25 -08:00
Maximilian Roos 83e6f2419c Add Google Analytics to track site usage 2025-12-01 19:31:00 -08:00
Maximilian Roos cbfffa0719 feat(docs): Add OpenGraph and Twitter Card meta tags 2025-12-01 19:29:34 -08:00
Maximilian Roos 9b87d9c5d3 Docs: Update navigation menu links 2025-12-01 19:26:32 -08:00
Maximilian Roos d3495bd5e8 feat(docs): Add warm workbench theme for documentation site (#82)
Implement a custom "warm workbench" theme for the Worktrunk documentation,
built on the Juice Zola theme. Key features:

- Warm color palette with WCAG AA compliant contrast ratios
- Sticky header and TOC with definitional CSS variable positioning
- Smooth scroll behavior for anchor links and hero buttons
- Logo preload to prevent flash on navigation
- Scrollbar-gutter: stable to prevent layout shift
- Responsive breakpoints with variable overrides
- IntersectionObserver intercept to disable conflicting scroll-spy

The layout system uses CSS custom properties (--wt-header-height,
--wt-main-padding-top) so all dependent calculations stay in sync
automatically, preventing visual jumps when the TOC transitions to
sticky mode.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>
2025-12-01 19:08:10 -08:00
Maximilian Roos 2da8c3304c feat(config): Introduce wt config var command
Renames `wt config status` to `wt config var`, allowing the management
of various runtime variables stored in git config.

This change:
- Renames `worktrunk.status.<branch>` to `worktrunk.marker.<branch>` for consistency.
- Extends the command to support `get` operations for `default-branch`, `marker`, and `ci-status`.
- Updates all references in documentation, plugin hooks, and internal code.
2025-12-01 13:58:05 -08:00
Maximilian Roos 63879dcae7 Docs: Add terminal shortcode with ANSI to HTML conversion
This commit introduces:
- A new `ansi-to-html` dependency to convert ANSI escape codes in terminal output to HTML.
- A `terminal` shortcode for the documentation, which wraps the converted HTML output.
- Updates to `quickstart.md` and `configuration.md` to use this new shortcode.
- Corresponding changes in the `readme_sync.rs` test to generate and check the HTML output.
- Basic styling for the new `.terminal` class in `custom.scss`.
2025-12-01 08:56:13 -08:00
Maximilian Roos 301419bd01 Refactor merge message reasons for clarity 2025-12-01 07:28:49 -08:00
Maximilian Roos fb791b5c29 docs: Generate command reference from help --md
- Replaces static command documentation in `docs/content/commands.md` with auto-generated content from `wt <command> --help-md`.
- Moves advanced tips and patterns to a new `docs/content/tips-patterns.md` page.
- Updates navigation weights and `wt select` documentation to reflect these changes.
- Adds an integration test to ensure the generated documentation remains in sync with the CLI help output.
2025-12-01 07:10:13 -08:00
Maximilian Roos 22c7b1efc1 docs: Clean up custom SASS stylesheet
Removes custom styling that the theme now provides or is no longer needed.
Adds comments to remaining styles explaining their purpose.
2025-11-30 18:55:14 -08:00