signal-works/angrymichigander
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description https://angrymichigander.com
17 commits 1 branch 0 tags 898 KiB
  • PostScript 100%
Find a file
Exact
Decobus e44353a514
All checks were successful
Deploy to S3 / deploy (push) Successful in 51s
Details
Add comprehensive project documentation (#3) 
## Summary
Add complete project documentation suite to improve developer experience and project understanding.

## Documentation Added
- **PROJECT_INDEX.md**: Complete project overview, architecture, configuration reference
- **DEVELOPMENT_GUIDE.md**: Step-by-step setup, development workflow, testing, deployment
- **QUICK_REFERENCE.md**: Fast command reference and common operations
- **README.md**: Documentation index and navigation

## Benefits
- Clear onboarding for new developers
- Comprehensive reference for AI assistants (Claude Code)
- Quick access to common commands and workflows
- Detailed architecture and configuration documentation

## Test Plan
- [x] All documentation files created and organized
- [x] Cross-references between docs are accurate
- [x] Command examples verified
- [x] File paths and references validated

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

Co-authored-by: Decobus <deco@deco.sh>
Reviewed-on: #3
2025-10-14 20:36:40 +03:00
.forgejo/workflows Update .forgejo/workflows/deploy.yml 2025-07-17 21:51:33 +03:00
archetypes Initial commit: Add Hugo site structure and configuration 2025-06-29 20:37:51 -04:00
assets Add Lynx theme with Hugo modules and optimized author image 2025-06-29 22:15:26 -04:00
docs Add comprehensive project documentation (#3) 2025-10-14 20:36:40 +03:00
.gitignore Add Lynx theme with Hugo modules and optimized author image 2025-06-29 22:15:26 -04:00
CLAUDE.md Add CLAUDE.md documentation for future Claude Code instances 2025-07-17 14:30:30 -04:00
go.mod Add Lynx theme with Hugo modules and optimized author image 2025-06-29 22:15:26 -04:00
go.sum Add Lynx theme with Hugo modules and optimized author image 2025-06-29 22:15:26 -04:00
hugo.yaml Add Lynx theme with Hugo modules and optimized author image 2025-06-29 22:15:26 -04:00
README.md Add comprehensive project documentation (#3) 2025-10-14 20:36:40 +03:00

README.md

The Angry Michigander

Personal blog platform built with Hugo and the Lynx theme.

Quick Start

# Development server with drafts
hugo server -D

# Production build
hugo --minify

Documentation

📚 Comprehensive documentation available in docs/:

Technology Stack

  • Static Site Generator: Hugo (Extended)
  • Theme: Lynx v1.4.0
  • Deployment: AWS S3 via Forgejo Actions
  • Version Control: Forgejo (with tea CLI)

Key Commands

# Content creation
hugo new posts/my-post.md

# Local preview
hugo server -D

# Production build
hugo --minify

# Module management
hugo mod get -u              # Update all modules
hugo mod tidy               # Clean dependencies

CI/CD

Automatic deployment to AWS S3 on push to main branch via Forgejo Actions.

Getting Help

License

Personal project - All rights reserved.