# 📚 Documentation Index - Burger Menu Feature

**Created:** November 24, 2025  
**Feature:** Adaptive Mobile Navigation (Burger Menu)

---

## 🗂️ Where is this feature documented?

| File | Section | Purpose | Priority |
|------|---------|---------|----------|
| **`BURGER_MENU_FEATURE.md`** | All | **MAIN DOCUMENTATION** - Complete guide | ⭐⭐⭐ |
| `docs/CLI_AGENT_MASTER.md` | Line ~70 | Quick reference for agents | ⭐⭐⭐ |
| `docs/REFERENCE.md` | Line ~420 | User preferences schema | ⭐⭐ |
| `AGENTS.md` | Line ~5 | Critical features list | ⭐⭐ |
| `AppShell.vue` | Lines 1-30 | Inline warnings in code | ⭐ |
| `BURGER_MENU_COMPLETE.md` | All | Implementation notes | ⭐ |

---

## 🔍 Quick Search Guide

### For AI Agents

**"How does mobile navigation work?"**  
→ Read `BURGER_MENU_FEATURE.md` (complete guide)

**"Where is AppShell.vue logic?"**  
→ `apps/web/src/app/components/AppShell.vue` line ~360

**"What is mobileNavType?"**  
→ `docs/REFERENCE.md` line ~420 (User preferences schema)

**"Can I remove burger menu code?"**  
→ ❌ NO! Read `BURGER_MENU_FEATURE.md` → "Common Mistakes" section

### For Developers

**"How do I test burger menu?"**  
→ `BURGER_MENU_FEATURE.md` → "Testing Checklist" section

**"Where is the settings UI?"**  
→ `apps/web/src/modules/settings/components/PreferencesSection.vue`

**"What files were modified?"**  
→ `BURGER_MENU_FEATURE.md` → "Files Modified" section

---

## 📝 Documentation Coverage

### Complete Documentation (✅)

- ✅ Feature overview
- ✅ Architecture explanation
- ✅ Code locations
- ✅ Logic flow
- ✅ UI mockups
- ✅ Backend implementation
- ✅ Frontend implementation
- ✅ Styling details
- ✅ Testing checklist
- ✅ Troubleshooting guide
- ✅ Common mistakes
- ✅ Contributing guidelines

### Quick Reference (✅)

- ✅ Agent lookup tables
- ✅ File patterns
- ✅ Module locations
- ✅ API endpoints
- ✅ Type definitions

### Inline Code (✅)

- ✅ AppShell.vue header comment (30 lines)
- ✅ Danger zone markers
- ✅ Logic explanations

---

## 🎯 Agent Protocol

**When modifying AppShell.vue:**

1. ⚠️ **STOP** - Read warning comment (lines 1-30)
2. 📖 **READ** - `BURGER_MENU_FEATURE.md` (5 minutes)
3. 🔍 **CHECK** - 4 files involved (types, validators, AppShell, PreferencesSection)
4. ✅ **TEST** - Run checklist from documentation
5. 🚀 **COMMIT** - Only if all tests pass

**Emergency contacts:**
- Main doc: `BURGER_MENU_FEATURE.md`
- Quick ref: `docs/CLI_AGENT_MASTER.md` line ~70
- Schema: `docs/REFERENCE.md` line ~420

---

## 📊 Statistics

| Metric | Value |
|--------|-------|
| Documentation files | 6 |
| Total doc lines | 500+ |
| Code files modified | 4 |
| Code lines added | ~270 |
| Test cases | 20+ |
| Common mistakes documented | 3 |

---

## ✅ Validation

- ✅ Type-check passes
- ✅ Build succeeds
- ✅ All files documented
- ✅ Agent warnings in place
- ✅ Quick reference tables complete
- ✅ Troubleshooting guide included

---

**Last Updated:** November 24, 2025  
**Status:** ✅ Fully Documented
