libra/docs/stories/story-12.6-documentation-up...

182 lines
5.8 KiB
Markdown

# Story 12.6: Brand Documentation Update - Dark Charcoal & Warm Gold
## Story
**As a** developer
**I want to** update all brand documentation to reflect the new dark charcoal and warm gold color palette
**So that** documentation accurately represents the current brand identity
## Acceptance Criteria
### AC1: Update `docs/brand.md`
**Given** the brand documentation references old colors
**When** I update the file
**Then** the following sections are updated:
- Color palette section with new hex values
- Color usage guidelines
- Any color swatches or examples
**New Color Palette:**
| Color Name | Hex | Usage |
|------------|-----|-------|
| Dark Forest Green | `#2D3624` | Header/Footer backgrounds |
| Warm Gold | `#A68966` | CTA buttons, links, accents |
| Warm Cream | `#F4F1EA` | Main page background |
| Forest Green | `#2D322A` | Headings, body text |
| Pure White | `#FFFFFF` | Card backgrounds |
| Olive Green | `#4A5D23` | Active states |
| Gold Hover | `#8A7555` | Button hover states |
| Gold Light | `#C4A882` | Light accents |
| Primary Light | `#3D4634` | Primary hover states |
### AC2: Update `CLAUDE.md`
**Given** CLAUDE.md contains design requirements with old colors
**When** I update the file
**Then** the Design Requirements section reflects new palette:
- Update color scheme description
- Update hex values
- Maintain bilingual requirement notes
### AC3: Update `docs/architecture.md` (if applicable)
**Given** architecture docs may reference brand colors
**When** I review the file
**Then** any color references are updated to new palette
### AC4: Update `docs/prd.md` (if applicable)
**Given** PRD may reference brand colors
**When** I review the file
**Then** any color references are updated to new palette
### AC5: Update Test Color Assertions
**Given** tests may assert specific color values
**When** I review test files
**Then** color assertions are updated:
- `tests/Feature/Admin/PdfBrandColorsTest.php`
- Any other tests checking brand colors
### AC6: Review and Update Code Comments
**Given** code comments may reference old color names
**When** I review key files
**Then** comments are updated:
- `resources/css/app.css` - CSS comments
- Any inline style comments in Blade files
### AC7: Update Logo Generation Instructions (if exists)
**Given** `docs/logo-generation-instructions.md` may exist
**When** I review the file
**Then** any color references match new palette
## Technical Notes
### Files to Review/Modify
**Documentation:**
- `docs/brand.md` - Primary brand documentation
- `CLAUDE.md` - Project instructions
- `docs/architecture.md` - Architecture documentation
- `docs/prd.md` - Product requirements
**Tests:**
- `tests/Feature/Admin/PdfBrandColorsTest.php`
- Any other brand color tests
**Code Comments:**
- `resources/css/app.css`
### Color Reference Quick Sheet
```
Primary Colors:
- Dark Forest Green: #2D3624 (header/footer bg)
- Warm Gold: #A68966 (CTA, links)
- Warm Cream: #F4F1EA (page background)
- Forest Green: #2D322A (text)
- Pure White: #FFFFFF (cards)
- Olive Green: #4A5D23 (active states)
Variants:
- Primary Light: #3D4634
- Gold Hover: #8A7555
- Gold Light: #C4A882
- Olive Hover: #5A7030
```
### CLAUDE.md Design Requirements Update
Replace the existing color scheme section with:
```markdown
- **Color scheme:**
- Dark Forest Green (#2D3624) - Header/Footer backgrounds
- Warm Gold (#A68966) - CTA buttons, links, accents
- Warm Cream (#F4F1EA) - Main page background
- Forest Green (#2D322A) - Headings, body text
- Pure White (#FFFFFF) - Card backgrounds
- Olive Green (#4A5D23) - Active states
```
## Dev Checklist
- [x] Update `docs/brand.md` color palette section
- [x] Update `docs/brand.md` color usage guidelines
- [x] Update `CLAUDE.md` Design Requirements section
- [x] Review `docs/architecture.md` for color references
- [x] Review `docs/prd.md` for color references
- [x] Update `PdfBrandColorsTest.php` assertions
- [x] Review other test files for color assertions
- [x] Update CSS comments in `app.css`
- [x] Review `docs/logo-generation-instructions.md` if exists
- [x] Final review of all documentation for consistency
## Estimation
**Complexity:** Low
**Risk:** Low - Documentation only, no code changes
## Dependencies
- Stories 12.2, 12.3, 12.4, 12.5 must be completed first
- New colors must be implemented and verified before documenting
---
## Dev Agent Record
### Status
Ready for Review
### Agent Model Used
Claude Opus 4.5
### File List
- `docs/brand.md` - Updated color palette section with new Dark Forest Green & Warm Gold palette
- `CLAUDE.md` - Updated Design Requirements section with new color scheme
- `docs/architecture.md` - Updated CSS theme variables and color palette reference table
- `docs/prd.md` - Updated all color references throughout (color palette, buttons, logo specs, visual elements)
- `tests/Feature/AccessibilityComplianceTest.php` - Updated WCAG color contrast tests for new palette
- `docs/logo-generation-instructions.md` - Updated brand color reference section
### Change Log
| Date | Change |
|------|--------|
| 2026-01-04 | Story created for documenting new Dark Charcoal & Warm Gold palette |
| 2026-01-04 | Completed all documentation updates for new brand colors |
### Completion Notes
- All documentation files updated to reference new Dark Forest Green (#2D3624) and Warm Gold (#A68966) palette
- Replaced all old color references (Charcoal #4A4A42, Warm Gray #C9C4BA, Off-White #E8E4DC)
- Updated test assertions in AccessibilityComplianceTest.php to match new CSS variable values
- PdfBrandColorsTest.php was already updated in previous stories (12.2-12.5)
- CSS app.css already had correct comments from Story 12.2 implementation
- All color-related tests pass (5 WCAG Color Contrast tests, 6 PDF Brand Color tests)
- Note: Some pre-existing test failures in AccessibilityComplianceTest.php unrelated to this story (role="main" landmark issues)