Commit Graph

59 Commits

Author SHA1 Message Date
Maximilian Roos 891a2b3205 Move demo GIF to external assets repo to reduce repo size
Local preview workflow: build demo → copy to docs/static/assets/ → serve
locally. CI workflow: fetch GIF from worktrunk-assets repo during build.
README references CDN URL for GitHub display.

Add publish-assets script to push built demos to external repo. Update
.gitignore to exclude both dev output and docs preview copies. Update
quickstart.md image path to /assets/wt-demo.gif for both local and CI
builds. Expand dev/wt-demo/CLAUDE.md with complete path documentation
showing how all three workflows (local preview, CI build, README CDN)
connect through the shared asset.
2025-12-03 13:24:43 -08:00
Maximilian Roos c8c49a63e6 docs: improve wt list docs with colored CI dots and progressive display
Restructure CI status documentation with colored indicator table and add
progressive rendering explanation. Convert CI status symbols from bullet
list to table format for clarity, and implement HTML colorization of CI
dots in web docs via new `colorize_ci_status_for_html()` function. Add
web compatibility guide to CLAUDE.md explaining post-processing of CLI
content for docs.
2025-12-03 09:21:52 -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 db0e998e3d Docs: Add explanation of command documentation generation 2025-12-02 18:26:18 -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 d158d77887 Docs: Remind to include dev server link in response 2025-12-02 14:24:52 -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 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 1be558a785 feat: Add GitHub Pages deployment workflows (#65)
* Refactor: Standardize user messages for improved clarity

This commit introduces a set of refinements to user-facing messages across the application. The goal is to ensure consistency in tone, terminology, and presentation, making interactions more intuitive and understandable for users.

* feat: Add a documentation site for Worktrunk

This commit adds the initial scaffolding for the Worktrunk documentation site, built with Zola and a customized Juice theme.

The site includes:
- Basic configuration (`config.toml`)
- Custom SASS styling (`custom.scss`)
- Custom SVG logos and favicons
- Overridden Zola templates (`base.html`, `index.html`, `page.html`)
- Markdown content for:
    - Quick Start
    - Concepts
    - Configuration
    - Commands Reference
    - Advanced Features
    - FAQ

The content is an initial auto-generated draft and requires review for accuracy and completeness before being considered production-ready. A `CLAUDE.md` file is included to highlight this and list necessary verification steps.

* feat: Add GitHub Pages deployment workflows

Build Zola docs site and deploy to worktrunk.dev on push to main.

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

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: Claude <noreply@anthropic.com>
2025-11-30 18:22:28 -08:00