Skip to content

HW Design Workflow - Quick Reference

Your Personal Branch: HW-Design

This is your workspace for testing style and content changes before sharing with the team.

Daily Workflow

Start Working

# Switch to your design branch
git checkout HW-Design

# Make sure you're up to date
git pull origin HW-Design

Make Changes

Edit any of these: - Styles: docs/stylesheets/extra.css - Layout: mkdocs.yml - Content: Any .md files in docs/

Test Locally

# Quick rebuild and serve
python scripts/krr.py

# Or just serve
python -m mkdocs serve

View at: http://127.0.0.1:8000

Save Your Work

# Save changes
git add .
git commit -m "Design: [what you changed]"

# Optional: Push to GitHub to backup
git push origin HW-Design

Share with Team (When Ready)

# Switch to main branch
git checkout main

# Pull latest changes
git pull origin main

# Merge your approved changes
git merge HW-Design

# Push to GitHub
git push origin main

# Notify developers: "Please deploy - merged design changes to main"

What Developers Do Next

After you push to main, developers will: 

git checkout cloud-deploy
git merge main
git push origin cloud-deploy  # This triggers cloud deployment

Quick Commands

Action Command
Switch to your branch git checkout HW-Design
See current branch git branch
Test changes locally python scripts/krr.py
Save work git add . && git commit -m "Design: [msg]"
Share with team git checkout main && git merge HW-Design && git push

File Locations

Style Files

  • docs/stylesheets/extra.css - Custom CSS
  • mkdocs.yml - Site configuration

Content Files

  • docs/business/ - Business documentation
  • docs/models/ - Business models
  • docs/architecture/ - Architecture docs
  • docs/development/ - Developer guides

Tips

✅ DO: - Test all changes locally before merging to main - Commit often with clear messages - Ask developers to deploy after merging to main

❌ DON'T: - Push directly to cloud-deploy (developers handle this) - Delete the HW-Design branch (it's your permanent workspace) - Worry about cloud configuration (developers handle this)

Your Role vs Developer Role

You (HW) Handle:

  • ✅ Design and styling
  • ✅ Content and structure
  • ✅ Layout experiments
  • ✅ Testing locally
  • ✅ Merging to main when satisfied

Developers Handle:

  • ✅ Cloud deployment
  • ✅ Server configuration
  • ✅ Cloud-specific optimizations
  • ✅ Automated builds
  • ✅ Production monitoring

Need Help?

Check the full guide: deployment-branches.md

Your Branch: HW-Design
Testing: http://127.0.0.1:8000 (after python scripts/krr.py)
Last Updated: January 2025