Skip to content

Latest commit

Β 

History

History
76 lines (57 loc) Β· 3 KB

File metadata and controls

76 lines (57 loc) Β· 3 KB

Beethovens Werkstatt Website - Documentation

This folder contains all technical documentation for the Beethovens Werkstatt Jekyll website project.

πŸ“‹ Documentation Overview

πŸ—οΈ Project Status & Architecture

🎨 Design & Styling

🧭 Navigation & Structure

πŸ“„ Content Management

πŸš€ Quick Start

  1. Project Overview: Start with CURRENT_STATUS.md
  2. Development Setup: See main README.md in project root
  3. Styling System: Review SCSS_ARCHITECTURE.md

πŸ“ Documentation Structure

docs/
β”œβ”€β”€ README.md                    # This file - documentation index
β”œβ”€β”€ CURRENT_STATUS.md            # Complete project status
β”œβ”€β”€ SCSS_ARCHITECTURE.md         # SCSS modular structure
β”œβ”€β”€ REORGANIZATION_SUMMARY.md    # File organization changes
β”œβ”€β”€ DOCS_ORGANIZATION.md         # Documentation structure changes
β”œβ”€β”€ STYLING_SUMMARY.md           # Design and styling guide
β”œβ”€β”€ FONTS_SETUP.md               # Font management setup
β”œβ”€β”€ NAVIGATION_SUMMARY.md        # Navigation structure
β”œβ”€β”€ SPA_ISLANDS.md               # SPA islands implementation
└── PDF_GENERATION.md            # PDF export for glossary articles

πŸ”„ Maintenance

When adding new features or making changes:

  1. Update CURRENT_STATUS.md with new features
  2. Document any SCSS changes in SCSS_ARCHITECTURE.md
  3. Record major reorganizations in a new summary file
  4. Update this index when adding new documentation

🎯 Key Features Documented

  • βœ… Hero carousel with auto-advance
  • βœ… Modular SCSS architecture
  • βœ… Local font serving (Open Sans)
  • βœ… Responsive design system
  • βœ… Docker development environment
  • βœ… Dark footer with partner logos
  • βœ… Two-level dropdown navigation

πŸ“ž Development Notes

  • All documentation uses relative links for easy navigation
  • Documentation follows markdown best practices
  • Each file includes clear headings and structure
  • Status files are updated with each major change

Last Updated: July 2, 2025
Project: Beethovens Werkstatt Website
Framework: Jekyll with Docker