Skip to content

Conversation

@httpdss
Copy link
Owner

@httpdss httpdss commented Jul 27, 2025

🎬 VHS Demo Tapes Collection

This PR introduces a comprehensive collection of VHS (Video to ASCII) demo tapes that showcase STRUCT's capabilities through animated GIF demonstrations.

✨ What's Added

πŸŽ₯ 8 Complete Demo Tapes

  1. basic-usage.tape - Core commands (list, info, generate)
  2. yaml-config.tape - Custom YAML configuration creation with variables
  3. mappings-demo.tape - External mappings files and template variables
  4. multiple-mappings.tape - New deep merge feature for multiple mappings
  5. advanced-features.tape - Dry-run, file strategies, and validation
  6. remote-content.tape - GitHub and HTTP content fetching
  7. schema-generation.tape - JSON schema for IDE integration
  8. install.tape - Installation and setup (already existed)

πŸ“š Documentation & Automation

  • Comprehensive README.md - Complete documentation for all tapes
  • GitHub Actions Integration - Updated workflow to generate all tapes automatically
  • Consistent Configuration - All tapes use unified VHS settings
  • Usage Instructions - Clear guidance for generating and embedding GIFs

🎯 Demo Highlights

Basic Usage

struct list                           # List available structures
struct info terraform/module         # Get structure information
struct generate terraform/module ./output  # Generate project

YAML Configuration

Shows creating custom configurations with template variables and automatic file:// protocol handling.

Mappings & Variables

Demonstrates external mappings files for environment-specific configurations:

mappings:
  environments:
    dev: { database_url: "postgres://localhost:5432/dev" }
    prod: { database_url: "postgres://prod:5432/app" }

Multiple Mappings (New Feature)

Showcases the new deep merge capability:

struct generate \
  --mappings-file base-mappings.yaml \
  --mappings-file env-mappings.yaml \
  infrastructure.yaml ./output

Advanced Features

  • Dry-run previews: --dry-run
  • File strategies: --file-strategy=backup
  • Configuration validation: struct validate

Remote Content

Fetching from external sources:

files:
  - .gitignore:
      file: github://github/gitignore/main/Python.gitignore
  - LICENSE:
      file: https://raw.githubusercontent.com/licenses/...

Schema Generation

IDE integration support:

struct generate-schema -o struct-schema.json

πŸ”§ Technical Implementation

VHS Configuration

  • Theme: Monokai Vivid for professional appearance
  • Dimensions: 1400x800 for optimal readability
  • Timing: 40ms typing speed with strategic pauses
  • Shell: Bash for universal compatibility

GitHub Actions Integration

Updated workflow matrix to automatically generate all tapes:

matrix:
  tapes:
    - 'docs/vhs/install.tape'
    - 'docs/vhs/basic-usage.tape'
    - 'docs/vhs/yaml-config.tape'
    - 'docs/vhs/mappings-demo.tape'
    - 'docs/vhs/multiple-mappings.tape'
    - 'docs/vhs/advanced-features.tape'
    - 'docs/vhs/remote-content.tape'
    - 'docs/vhs/schema-generation.tape'

πŸ“– Documentation Benefits

For Users

  • Visual Learning - See STRUCT in action before trying
  • Real Examples - Practical use cases and workflows
  • Feature Discovery - Understand advanced capabilities
  • Quick Reference - Visual command syntax guide

For Documentation

  • README Enhancement - Engaging visual content
  • Tutorial Support - Animated guides for complex features
  • Marketing Material - Professional demonstration videos
  • Onboarding - Faster user adoption through visual examples

πŸš€ Usage Instructions

Generate All GIFs

cd docs/vhs
vhs install.tape
vhs basic-usage.tape
vhs yaml-config.tape
# ... continue for all tapes

Embed in Documentation

![STRUCT Basic Usage](./docs/vhs/basic-usage.gif)

Automated Generation

The GitHub Actions workflow can be triggered manually to regenerate all GIFs when features change.

🎯 Impact

  • Improved User Experience - Visual demonstrations make STRUCT more accessible
  • Better Onboarding - New users can see capabilities immediately
  • Feature Showcase - Highlights both basic and advanced functionality
  • Professional Documentation - Elevates project presentation quality

This collection provides comprehensive visual documentation that will significantly improve user understanding and adoption of STRUCT's powerful features.

- Add 8 VHS tape files demonstrating key STRUCT capabilities
- Include basic-usage.tape for core commands (list, info, generate)
- Add yaml-config.tape showing custom YAML configuration creation
- Include mappings-demo.tape for external mappings and template variables
- Add multiple-mappings.tape showcasing new deep merge feature
- Include advanced-features.tape for dry-run, file strategies, validation
- Add remote-content.tape for GitHub/HTTP content fetching
- Include schema-generation.tape for IDE integration support
- Add comprehensive README.md with tape documentation and usage instructions
- Update GitHub Actions workflow to generate all tapes automatically

These tapes provide visual documentation for users to understand
STRUCT's capabilities through animated GIF demonstrations.
@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

βœ… All modified and coverable lines are covered by tests.
βœ… Project coverage is 66.04%. Comparing base (da51d5c) to head (45e9ff9).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #69   +/-   ##
=======================================
  Coverage   66.04%   66.04%           
=======================================
  Files          22       22           
  Lines        1240     1240           
  Branches      175      175           
=======================================
  Hits          819      819           
  Misses        384      384           
  Partials       37       37           

β˜” View full report in Codecov by Sentry.
πŸ“’ Have feedback on the report? Share it here.

πŸš€ New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@httpdss httpdss self-assigned this Jul 27, 2025
@httpdss httpdss added documentation Improvements or additions to documentation patch and removed feature labels Jul 27, 2025
@httpdss httpdss merged commit 2fa0e4c into main Jul 27, 2025
3 checks passed
@httpdss httpdss deleted the feature/vhs-demo-tapes branch July 27, 2025 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation patch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants