naser
/
libra
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
libra/docs/stories/story-10.6-documentation-up...

4.8 KiB
Raw Blame History

Story 10.6: Documentation Update

Story

As a developer I want to update all documentation to reflect the new brand colors So that future development references accurate color information

Acceptance Criteria

AC1: CLAUDE.md Updated

Given CLAUDE.md contains color guidance When I update the file Then the following sections are updated:

  • Design Requirements section
  • Color scheme references (Navy → Charcoal, Gold → Warm Gray)
  • Any hex value references

AC2: PRD Updated

Given docs/prd.md contains detailed color specifications When I update the document Then the following sections are updated:

  • Section 7.1 Brand Identity & Visual Guidelines
  • Color Palette table
  • All hex value references
  • Button styling specifications
  • Any Navy/Gold color mentions

AC3: Architecture Document Updated

Given docs/architecture.md may contain color references When I review and update the document Then any color references are updated to new palette

AC4: Epic 9 Stories Referenced as Superseded

Given Epic 9 stories implemented the original Navy+Gold palette When I review Epic 9 story files Then a note is added indicating colors were updated in Epic 10:

  • story-9.1-color-system-implementation.md
  • story-9.4-component-styling-buttons.md
  • story-9.5-component-styling-forms.md
  • Other affected stories

AC5: Epic 10 Document Updated

Given docs/epics/epic-10-brand-color-refresh.md exists When all stories are complete Then the epic document is updated with completion status

AC6: brand.md Verified Accurate

Given docs/brand.md defines the new brand When I review the document Then it accurately describes:

  • The botanical/wheat logo
  • Correct color palette (Charcoal, Warm Gray, Off-White, Deep Black)
  • Typography guidelines
  • Usage guidelines

AC7: No Stale Color References

Given documentation should be accurate When I search all markdown files for old hex values Then no references to old colors remain:

  • #0A1F44 (old Navy) - replaced or removed
  • #D4AF37 (old Gold) - replaced or removed
  • #F4E4B8 (old Gold Light) - replaced or removed
  • #F9F7F4 (old Cream) - replaced or removed
  • #2C3E50 (old Charcoal) - replaced or removed

Technical Notes

Files to Update

Core Documentation:

  • CLAUDE.md
  • docs/prd.md
  • docs/architecture.md
  • docs/brand.md (verify accuracy)

Epic Files:

  • docs/epics/epic-10-brand-color-refresh.md
  • docs/epics/epic-9-design-branding.md (add supersession note)

Story Files (44 files contain old hex values):

  • docs/stories/story-9.1-color-system-implementation.md
  • docs/stories/story-9.4-component-styling-buttons.md
  • docs/stories/story-9.5-component-styling-forms.md
  • docs/stories/story-9.6-component-styling-cards-containers.md
  • docs/stories/story-9.7-navigation-footer-styling.md
  • docs/stories/story-9.10-accessibility-compliance.md
  • And others found via grep

Color Replacement Reference

Old Color Old Hex New Color New Hex
Navy Blue #0A1F44 Charcoal #4A4A42
Gold #D4AF37 Warm Gray #C9C4BA
Gold Light #F4E4B8 Off-White #E8E4DC
Cream #F9F7F4 Off-White #E8E4DC
Charcoal #2C3E50 Deep Black #1A1A1A

Search Commands

To find all old color references:

# Find files with old hex values
grep -r "#0A1F44\|#D4AF37\|#F4E4B8\|#F9F7F4\|#2C3E50" docs/

# Find Navy/Gold word references
grep -ri "navy\|gold" docs/*.md

Documentation Update Pattern

For Epic 9 stories, add a note at the top:

> **Note:** The color values in this story were implemented with the original Navy+Gold palette.
> These colors were updated in Epic 10 (Brand Color Refresh) to the new Charcoal+Warm Gray palette.
> See `docs/brand.md` for current color specifications.

Dev Checklist

  • Update CLAUDE.md color references
  • Update docs/prd.md Section 7.1 Color Palette
  • Update docs/prd.md all other color references
  • Review and update docs/architecture.md
  • Verify docs/brand.md is accurate
  • Add supersession note to story-9.1-color-system-implementation.md
  • Add supersession note to story-9.4-component-styling-buttons.md
  • Add supersession note to story-9.5-component-styling-forms.md
  • Add supersession note to other affected Epic 9 stories
  • Update epic-10-brand-color-refresh.md with completion status
  • Run grep to verify no old hex values remain
  • Review all documentation for consistency

Estimation

Complexity: Low Risk: Low - Documentation only, no code impact

Dependencies

  • Should be completed last, after Stories 10.1-10.5 are done
  • Ensures documentation reflects actual implemented state