Commit Graph

12 Commits

Author SHA1 Message Date
Maximilian Roos 56d7bb825d fix(docs): exclude alternate pages from sitemap and add trailing slashes to nav (#2320)
Search Console flagged two indexing issues on worktrunk.dev:

**"Alternate page with proper canonical tag"**: the sitemap listed
`/worktrunk/`, which canonicalizes to `/` (its content is rendered on
the homepage via `templates/index.html`). Only canonicals belong in a
sitemap. Skip sitemap entries whose frontmatter declares a canonical.

**"Page with redirect"**: the `extra_menu` links `/worktrunk` and
`/tips-patterns` had no trailing slash, so every page's nav triggered a
301 on GitHub Pages. Added the trailing slashes.

Verified locally with `zola build`: sitemap goes from 14 to 13 entries
(no more `/worktrunk/`), `/worktrunk/` page still served with canonical
= `/`, and built nav hrefs now have trailing slashes.

Search Console also reported "Not found (404)" — those are old renamed
URLs (`/why-worktrunk/`, `/quickstart/`, `/advanced/`) that no longer
exist. Left alone here: a static 404 is correct, and adding meta-refresh
redirect stubs would just create new "Page with redirect" entries.

> _This was written by Claude Code on behalf of @max-sixty_

Co-authored-by: Claude <noreply@anthropic.com>
2026-04-19 22:38:15 -07:00
Maximilian Roos 1d85de945f Migrate docs syntax highlighting to giallo with warm theme (#1080)
## Summary

- Migrate from static CSS syntax highlighting to Zola's giallo engine
with custom `worktrunk-light.json` theme
- Replace hardcoded `syntax-light.css` / `syntax-dark.css` with
theme-based class generation
- Design a warm "sunlit workshop" palette: amber commands, gold strings,
chartreuse quoted strings, rusty constants
- Add CSS sibling selector to differentiate quoted from bare strings
(giallo tokenizes both as `z-string`)

## Test plan

- [ ] Verify syntax colors on `/switch/` (bash: commands, flags,
strings, quoted strings)
- [ ] Verify TOML blocks on `/config/` (section headers, keys, values)
- [ ] Verify dark mode is unaffected (quoted string CSS rule scoped to
`prefers-color-scheme: light`)
- [ ] Check all tests pass (`cargo test`)

> _This was written by Claude Code on behalf of @max-sixty_

---------

Co-authored-by: Claude <noreply@anthropic.com>
2026-02-17 11:32:21 -08:00
Maximilian Roos 61866ed27b Enable anchor links for documentation headings and refactor test fixtures
- Add `insert_anchor_links = "heading"` to Zola markdown config for automatic heading anchors
- Style anchor links with hover effects: h2 underlines intensify, h3/h4 shift to accent color
- Add `scroll-margin-top` to content area to account for sticky header when scrolling to anchors
- Wrap homepage and page title headings with anchor links for deep linking
- Add new test fixtures: `repo_with_remote_and_feature`, `repo_with_alternate_primary`, `repo_with_multi_commit_feature`, and `add_feature()` shorthand
- Consolidate help tests from individual functions to parameterized rstest
- Update directives and merge/push tests to use new fixture helpers
- Update snapshot tests with corrected commit messages from new fixture usage
2025-12-11 13:21:00 -08:00
Maximilian Roos 68904e5f1e Rename why-worktrunk page to worktrunk
Update documentation page title and file references from "Why Worktrunk?" to
"Worktrunk" for simpler naming. Update all related paths in config, templates,
and tests accordingly. Add "For context," to intro sentence for clarity.
2025-12-11 01:23:46 -08:00
Maximilian Roos 54d0ccd616 Remove Juice theme dependency, build standalone custom theme
Custom "warm workbench" theme now self-contained without Juice inheritance. Eliminates theme extension complexity and provides complete control over documentation site design.

Key changes:
- Removed docs/themes/juice submodule and all Juice template inheritance
- Rewrote base.html as standalone template with full HTML structure
- Migrated all Juice CSS variables and utilities into custom.scss
- Updated config.toml to remove theme reference and rename juice_* config keys
- Consolidated template structure: page.html and index.html now extend base.html directly
- Removed lychee exclusion for Juice theme README (no longer applicable)
- Moved normalize.css from theme to docs/static for direct control

The theme is now fully self-hosted with no external dependencies, making it easier to maintain and extend.
2025-12-05 19:08:20 -08:00
Maximilian Roos 076bacb710 Rename quickstart page to why-worktrunk
Updates documentation site navigation and homepage to reflect the new page name, replacing all references from "quickstart" to "why-worktrunk" across configuration, templates, and documentation.
2025-12-04 17:32:39 -08:00
Maximilian Roos a0b9a21be0 Docs: Implement dark mode for improved user experience 2025-12-02 16:17:46 -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 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 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 9b87d9c5d3 Docs: Update navigation menu links 2025-12-01 19:26:32 -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