Documentation Index

Last Updated: 2025-12-27

This directory contains all documentation for The Parlor (www.aledlie.com) Jekyll site.

Quick Start

• New to this project? Start with ARCHITECTURE-DATA-FLOWS.md for system overview
• Understanding the architecture? See ARCHITECTURE-DATA-FLOWS.md for data flows and patterns
• Setting up locally? See setup/ directory
• Working with Schema.org? See schema/ directory
• Refactoring the codebase? See refactoring/ directory

Directory Structure

docs/
├── schema/              # Schema.org implementation & SEO
├── refactoring/         # Codebase refactoring guides
├── setup/               # Local development setup
├── CHANGELOG.md         # Project change history
└── REFACTORING_STATUS.md

---

Schema.org Documentation

Purpose: Comprehensive Schema.org structured data implementation for SEO optimization

Core Guides

File	Description
schema/ENHANCED-SCHEMA-IMPLEMENTATION-GUIDE.md	Complete implementation guide for Schema.org markup
schema/SCHEMA-TESTING-VALIDATION-GUIDE.md	How to test and validate Schema.org changes
schema/SEARCH-CONSOLE-MONITORING-GUIDE.md	Monitoring Schema.org in Google Search Console

Analysis & Summaries

File	Description
schema/PERSONALSITE-SCHEMA-COMPLETE-ANALYSIS.md	Complete Schema.org analysis for the site
schema/BLOG-SCHEMA-ENHANCEMENT-ANALYSIS.md	Blog post schema enhancement analysis
schema/BLOG-SCHEMA-ENHANCEMENT-SUMMARY.md	Summary of blog schema improvements
schema/IMPLEMENTATION-COMPLETE-SUMMARY.md	Implementation completion summary

Entity Analysis

File	Description
schema/entity-analysis/ABOUT-PAGE-ENTITY-ANALYSIS.md	Schema for About page
schema/entity-analysis/BLOG-POST-ENTITY-ANALYSIS.md	Schema for blog posts
schema/entity-analysis/VITA-HOMAGE-ENTITY-ANALYSIS.md	Schema for CV/resume pages

---

Refactoring Documentation

Purpose: Guides for refactoring and improving the codebase

Master Guides

File	Description
refactoring/MASTER_IMPLEMENTATION_GUIDE.md	START HERE - Complete refactoring roadmap
refactoring/EXECUTIVE_SUMMARY.md	High-level overview of refactoring project
refactoring/README.md	Refactoring documentation index

Planning & Strategy

File	Description
refactoring/architecture-simplification-plan-2025-11-11.md	Architecture simplification strategy
refactoring/QUICK_START_CHECKLIST.md	Quick start checklist for refactoring
refactoring/PREFLIGHT_CHECKLIST.md	Pre-flight safety checks
refactoring/IMPLEMENTATION-CHECKLIST.md	Step-by-step implementation checklist

Testing

File	Description
refactoring/testing-strategy-2025-11-11.md	Comprehensive testing strategy
refactoring/TESTING-QUICKSTART.md	Quick start guide for testing
refactoring/TESTING-SUMMARY.md	Testing summary and results
refactoring/VISUAL-REGRESSION-TESTING-QUICK-GUIDE.md	Visual regression testing guide

SCSS & Styling

File	Description
refactoring/SCSS-CONSOLIDATION-CHECKLIST.md	SCSS consolidation checklist
refactoring/PHASE_1.5_SCSS_ANALYSIS_TEMPLATE.md	Template for SCSS analysis (Phase 1.5)
refactoring/UI-UX-REFACTORING-REVIEW.md	UI/UX refactoring review
refactoring/UI-UX-REVIEW-INDEX.md	UI/UX review index

Operations & Support

File	Description
refactoring/ROLLBACK_PROCEDURES.md	How to rollback changes safely
refactoring/TROUBLESHOOTING_GUIDE.md	Common issues and solutions
refactoring/FAQ.md	Frequently asked questions
refactoring/DECISION_TREES.md	Decision trees for refactoring choices
refactoring/ACCEPTANCE_CRITERIA.md	Success criteria for refactoring
refactoring/IMPLEMENTATION_SUMMARY.md	Implementation progress summary
refactoring/REFACTORING-RECOMMENDATIONS-SUMMARY.md	Summary of refactoring recommendations

---

Setup Documentation

Purpose: Local development environment setup and troubleshooting

File	Description
setup/DOPPLER_SETUP.md	Secrets management with Doppler
setup/BUILD_ISSUE_RESOLUTION.md	Common build issues and fixes
setup/RUBY_3.4.4_COMPATIBILITY_ISSUE.md	Ruby version compatibility notes

---

Top-Level Documentation

File	Description
CHANGELOG.md	Project change history - all notable changes
ARCHITECTURE-DATA-FLOWS.md	Comprehensive architecture and data flow documentation
REFACTORING_STATUS.md	Current refactoring status and progress

---

Related Documentation

• Project Instructions: /CLAUDE.md - Main project documentation for Claude Code
• Build Tools: /utils/ - Utility scripts and tools
• Test Documentation: /tests/ - Test suite documentation

---

Documentation Standards

File Naming

• Use UPPER-CASE-WITH-HYPHENS.md for guides and official docs
• Use lowercase-with-hyphens-YYYY-MM-DD.md for dated reports
• Keep filenames descriptive but concise

Organization

• schema/ - Schema.org, SEO, structured data
• refactoring/ - Code improvements, architecture changes
• setup/ - Environment setup, tooling, configuration

Maintenance

• Update this README when adding new documentation
• Archive outdated docs with _OLD suffix
• Keep REFACTORING_STATUS.md current with progress

---

Need Help?

1. Understanding the architecture? → ARCHITECTURE-DATA-FLOWS.md
2. Schema.org questions? → schema/ENHANCED-SCHEMA-IMPLEMENTATION-GUIDE.md
3. Refactoring stuck? → refactoring/TROUBLESHOOTING_GUIDE.md
4. Build issues? → setup/BUILD_ISSUE_RESOLUTION.md
5. General questions? → refactoring/FAQ.md

---

This documentation is for The Parlor (www.aledlie.com) - A Jekyll-based personal website