CMT Sites Documentation

Welcome to the CMT Sites technical documentation. This site serves as the single source of truth for all design specifications, component behaviors, and layout documentation across all CMT sites build with this repo.

About This Project

CMT Sites is a Hugo-based monorepo that hosts multiple brand websites. The project emphasizes:

• Performance - Fast load times and optimized assets
• Accessibility - WCAG AA compliance across all components
• Usability - Intuitive interfaces for both end users and content editors
• Design Quality - Consistent, professional visual language
• Code Quality - Maintainable, well-documented codebase

Documentation Structure

This documentation is organized into sections:

Components

Reusable UI elements like buttons, cards, forms, and navigation elements. Each component page includes:

• Visual snapshots of all states (default, hover, active, disabled, error, etc.)
• Behavior specifications from user and admin perspectives
• Acceptance criteria for QA

Optional:

• Accessibility requirements
• Responsiveness rules

Layouts

Page templates used across the sites. Each layout page documents:

• Overall structure and component composition
• Content requirements from CMS
• SEO and meta tag requirements
• Responsive behavior at each breakpoint

Flows

User journeys and admin workflows. Each flow page includes:

• Flow diagrams showing step-by-step processes
• Decision points and edge cases
• Error handling and validation rules
• Success and failure states

Version Control

All documentation is version-controlled in git alongside the codebase. Visual snapshots from Figma are exported and committed to ensure immutability. Each page displays its last modification date.