Skip to content

Commit 3cf5c04

Browse files
committed
docs: update README with new information architecture
- Add comprehensive IA documentation (Foundations, Brand, Product) - Update project structure to reflect new pages and components - Add detailed feature descriptions and navigation capabilities - Include direct links to all main sections - Update component list with new interactive elements
1 parent 9f1f11a commit 3cf5c04

File tree

1 file changed

+71
-20
lines changed

1 file changed

+71
-20
lines changed

README.md

Lines changed: 71 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
# Buzzvil Design
2-
<!-- Updated: Team members added --> System
1+
# Buzzvil Design System
32

4-
A modern, minimal design system website for Buzzvil, featuring a dark theme, interactive animations, and bilingual support (English/Korean).
3+
A comprehensive design system website for Buzzvil, featuring a modern dark theme, interactive animations, bilingual support (English/Korean), and a structured information architecture.
54

65
## 🌟 Features
76

7+
- **Structured Information Architecture**: Organized into Foundations, Brand, and Product sections
8+
- **Interactive Navigation**: Elegant section navigation with auto-scroll and active states
89
- **Dark Theme**: Minimal, Linear-inspired design with blue accent colors
910
- **Interactive Minimap**: Full-screen animated minimap with scroll-based progress
1011
- **Bilingual Support**: Seamless language switching between English and Korean
@@ -55,6 +56,25 @@ npm run dev
5556

5657
## 🎨 Design System
5758

59+
### Information Architecture
60+
61+
#### Foundations (`/`)
62+
- **The Mission**: Mission & Vision statements
63+
- **Our Mindset**: Philosophy and design approach
64+
- **How we work**: Core values and working principles
65+
- **The team**: Meet the design team
66+
- **Tools**: Design and development tools
67+
68+
#### Brand (`/design/brand`)
69+
- **Principles**: Brand principles and guidelines
70+
- **Guidelines**: Comprehensive brand guidelines
71+
- **Resources**: Brand assets and templates
72+
73+
#### Product (`/design/product`)
74+
- **Principles**: Product design principles (Reward = Time, Delight Without Deception, Scalable by Design)
75+
- **Guidelines**: Product design guidelines
76+
- **Resources**: Product design resources
77+
5878
### Color Palette
5979
- **Primary**: Black (#000000)
6080
- **Accent**: Blue (#3B82F6)
@@ -68,10 +88,12 @@ npm run dev
6888

6989
### Components
7090
- Interactive Minimap
91+
- Section Navigation (auto-scroll, active states)
7192
- Language Switcher
7293
- Blur Reveal Animations
7394
- Parallax Sections
74-
- Avatar Generator
95+
- Values Slider (3D transitions)
96+
- Product Principles (interactive elements)
7597

7698
## 🌐 Internationalization
7799

@@ -98,21 +120,29 @@ npm run deploy
98120

99121
```
100122
src/
101-
├── app/ # Next.js App Router
102-
│ ├── globals.css # Global styles and CSS variables
103-
│ ├── layout.tsx # Root layout
104-
│ └── page.tsx # Home page
105-
├── components/ # React components
106-
│ ├── Header.tsx # Navigation header
107-
│ ├── Hero.tsx # Hero section
108-
│ ├── InteractiveMinimap.tsx # Animated minimap
109-
│ ├── LanguageSwitcher.tsx # Language toggle
123+
├── app/ # Next.js App Router
124+
│ ├── design/ # Design system pages
125+
│ │ ├── brand/ # Brand page (/design/brand)
126+
│ │ └── product/ # Product page (/design/product)
127+
│ ├── globals.css # Global styles and CSS variables
128+
│ ├── layout.tsx # Root layout
129+
│ ├── page.tsx # Homepage (Foundations)
130+
│ └── not-found.tsx # 404 error page
131+
├── components/ # React components
132+
│ ├── Header.tsx # Navigation header
133+
│ ├── Hero.tsx # Hero section
134+
│ ├── SectionNavigation.tsx # Section navigation
135+
│ ├── Values.tsx # Values slider
136+
│ ├── ProductPrinciples.tsx # Product principles
137+
│ ├── SectionPlaceholder.tsx # Placeholder components
138+
│ ├── InteractiveMinimap.tsx # Animated minimap
139+
│ ├── LanguageSwitcher.tsx # Language toggle
110140
│ └── ...
111-
├── contexts/ # React contexts
112-
│ └── LanguageContext.tsx # Language management
113-
└── utils/ # Utility functions
114-
├── avatar.ts # Avatar generation
115-
└── clamp.ts # Math utilities
141+
├── contexts/ # React contexts
142+
│ └── LanguageContext.tsx # Language management & translations
143+
└── utils/ # Utility functions
144+
├── avatar.ts # Avatar generation
145+
└── teamParser.ts # Team data parsing
116146
```
117147

118148
## 🤝 Contributing
@@ -138,9 +168,30 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
138168
## 🔗 Links
139169

140170
- [Live Site](https://design.buzzvil.com)
171+
- [Foundations](https://design.buzzvil.com/) - Mission, Philosophy, Values, Team, Tools
172+
- [Brand](https://design.buzzvil.com/design/brand) - Brand principles, guidelines, and resources
173+
- [Product](https://design.buzzvil.com/design/product) - Product design principles and guidelines
141174
- [Buzzvil](https://buzzvil.com)
142-
- [Design System Documentation](https://design.buzzvil.com/foundations)
175+
176+
## 🎯 Key Features
177+
178+
### Navigation
179+
- **Elegant Section Navigation**: Fixed sub-navigation with auto-scroll and active states
180+
- **Smooth Transitions**: Seamless page transitions and scroll animations
181+
- **Responsive Design**: Optimized for desktop, tablet, and mobile
182+
183+
### Content
184+
- **Interactive Principles**: 3D animated product principles with interactive elements
185+
- **Values Slider**: Auto-advancing values showcase with smooth transitions
186+
- **Team Showcase**: Dynamic team member profiles with avatars
187+
- **Bilingual Support**: Complete English and Korean translations
188+
189+
### Technical
190+
- **Modern Architecture**: Next.js 15 with App Router
191+
- **Type Safety**: Full TypeScript implementation
192+
- **Performance**: Optimized with Tailwind CSS and Framer Motion
193+
- **Accessibility**: WCAG compliant navigation and interactions
143194

144195
---
145196

146-
Built with ❤️ by the Buzzvil Design Team# Trigger deployment
197+
Built with ❤️ by the Buzzvil Design Team

0 commit comments

Comments
 (0)