Skip to content

Latest commit

 

History

History
215 lines (201 loc) · 8.2 KB

STRUCTURE.md

File metadata and controls

215 lines (201 loc) · 8.2 KB

Documentation Structure

Visual overview of the documentation organization.

docs/
├── INDEX.md                    # Complete documentation index
├── README.md                   # Getting started guide
├── STRUCTURE.md               # This file - visual structure
│
├── features/                   # Feature Documentation (64 files)
│   ├── abstracts/             # Abstract Portal (11 files)
│   │   ├── ABSTRACT_PORTAL_BEFORE_AFTER.md
│   │   ├── ABSTRACT_PORTAL_COMPLETE_SUMMARY.md
│   │   ├── ABSTRACT_PORTAL_IMPLEMENTATION.md
│   │   ├── ABSTRACT_PORTAL_NEW_LAYOUT_GUIDE.md
│   │   ├── ABSTRACT_PORTAL_QUICK_START.md
│   │   ├── ABSTRACT_PORTAL_SIDEBAR_SUMMARY.md
│   │   ├── ABSTRACT_PORTAL_SIDEBAR_UPDATE.md
│   │   ├── ABSTRACT_PORTAL_TESTING_GUIDE.md
│   │   ├── ABSTRACT_PORTAL_VISUAL_GUIDE.md
│   │   ├── ABSTRACTS_LIST_FINAL_POLISH.md
│   │   └── ABSTRACTS_PAGE_IMPROVEMENTS.md
│   │
│   ├── accommodation/         # Accommodation System (7 files)
│   │   ├── ACCOMMODATION_CHECKLIST.md
│   │   ├── ACCOMMODATION_FEATURE.md
│   │   ├── ACCOMMODATION_FLOW_DIAGRAM.md
│   │   ├── ACCOMMODATION_IMPLEMENTATION_SUMMARY.md
│   │   ├── ACCOMMODATION_MENU_STRUCTURE.md
│   │   ├── ACCOMMODATION_QUICK_REFERENCE.md
│   │   └── ACCOMMODATION_UI_GUIDE.md
│   │
│   ├── attendees/             # Attendee Management (4 files)
│   │   ├── ATTENDEES_PAGE_SUMMARY.md
│   │   ├── ATTENDEE_CHECKINS_IMPLEMENTATION.md
│   │   ├── MANAGE_ATTENDEES_FILTER_BAR_UPDATE.md
│   │   └── MANAGE_ATTENDEES_UPDATES.md
│   │
│   ├── authentication/        # Auth System (17 files)
│   │   ├── AUTHENTICATION_IMPLEMENTATION.md
│   │   ├── FORGOT_PASSWORD_BEFORE_AFTER.md
│   │   ├── FORGOT_PASSWORD_FLOW.md
│   │   ├── FORGOT_PASSWORD_UPDATES.md
│   │   ├── FORGOT_PASSWORD_VISUAL_GUIDE.md
│   │   ├── LOGIN_CREDENTIALS.md
│   │   ├── LOGIN_FORM_UPDATES_SUMMARY.md
│   │   ├── LOGIN_HERO_UPDATES.md
│   │   ├── LOGIN_PAGE_DESIGN.md
│   │   ├── LOGIN_QUICK_REFERENCE.md
│   │   ├── LOGIN_UPDATES_SUMMARY.md
│   │   ├── SIGNUP_FINAL_UPDATES.md
│   │   ├── SIGNUP_FLOW_GUIDE.md
│   │   ├── SIGNUP_PROGRESS_BAR.md
│   │   ├── SIGNUP_QUICK_REFERENCE.md
│   │   ├── SIGNUP_STEPPER_FINAL.md
│   │   └── SIGNUP_UI_UPDATES.md
│   │
│   ├── coupons/               # Coupon System (2 files)
│   │   ├── COUPON_REDESIGN_SUMMARY.md
│   │   └── PROMO_DISCOUNTS_TABLE_UPDATE.md
│   │
│   ├── email-builder/         # Email Builder (18 files)
│   │   ├── EMAIL_BUILDER_COMPACT_DESIGN.md
│   │   ├── EMAIL_BUILDER_COMPONENTS_UPDATE.md
│   │   ├── EMAIL_BUILDER_DRAG_DROP_FIX.md
│   │   ├── EMAIL_BUILDER_FIXES.md
│   │   ├── EMAIL_BUILDER_GUIDE.md
│   │   ├── EMAIL_BUILDER_MAILY_COMPONENTS.md
│   │   ├── EMAIL_BUILDER_SETTINGS_SIDEBAR.md
│   │   ├── EMAIL_BUILDER_SIDEBAR_FEATURE.md
│   │   ├── EMAIL_BUILDER_TESTING_GUIDE.md
│   │   ├── EMAIL_DELIVERY_TROUBLESHOOTING.md
│   │   ├── EMAIL_SENDING_READY.md
│   │   ├── EMAIL_SENDING_SETUP.md
│   │   ├── MAILY_BLOCKS_GUIDE.md
│   │   ├── MAILY_COLUMN_BUG.md
│   │   ├── MAILY_INTEGRATION_STATUS.md
│   │   ├── PROFESSIONAL_EMAIL_TEMPLATE.md
│   │   ├── TECH_INNOVATION_SUMMIT_TEMPLATE.md
│   │   └── WELCOME_EMAIL_TEMPLATE.md
│   │
│   ├── tickets/               # Ticket Portal (1 file)
│   │   └── TICKET_PORTAL_ENHANCEMENTS.md
│   │
│   └── (root level)           # General Features (4 files)
│       ├── ADDITIONAL_INFO_SECTION.md
│       ├── ANALYTICS_MENU_ADDITION.md
│       ├── CC_EMAIL_FEATURE.md
│       └── IMPORT_USERS_FEATURE.md
│
├── guides/                     # User & Developer Guides (6 files)
│   ├── DEPLOY_TEMPLATE_GUIDE.md
│   ├── FILTER_BAR_QUICK_GUIDE.md
│   ├── IMAGE_REPLACEMENT_GUIDE.md
│   ├── NEW_FILTERS_QUICK_GUIDE.md
│   └── QUICK_START_LOGIN.md
│
├── implementations/            # Implementation Details (2 files)
│   ├── FLOW2_CHANGES.md
│   └── FLOW2_DOCUMENTATION.md
│
├── ui-components/             # UI Component Docs (18 files)
│   ├── COLUMN_SORTING_UPDATE.md
│   ├── COMPACT_TABLE_UPDATE.md
│   ├── COMPACT_UI_UPDATE.md
│   ├── DELETE_CONFIRMATION_MODAL.md
│   ├── FILTER_BADGE_EXTRA_COMPACT.md
│   ├── FILTER_BAR_COMPLETE_UPDATE.md
│   ├── FILTER_BAR_FINAL_UPDATE.md
│   ├── FINAL_TABLE_POLISH.md
│   ├── FINAL_TEMPLATE_AS_BASE.md
│   ├── FINAL_UI_POLISH.md
│   ├── IMAGE_PATHS_IN_TEMPLATE.md
│   ├── SCHEDULES_ANALYSIS.md
│   ├── SHIMMER_LOADING.md
│   ├── SIDEBAR_FINAL_UPDATES.md
│   ├── SIDEBAR_POLISH_UPDATES.md
│   ├── SIDEBAR_STYLING_IMPROVEMENTS.md
│   ├── STICKY_COLUMNS_AND_PAGINATION.md
│   └── TABLE_FIXES_FINAL.md
│
├── fixes/                      # Bug Fixes (7 files)
│   ├── EDIT_TEMPLATE_FIX.md
│   ├── FLOW2_FIXES.md
│   ├── PAGINATION_AND_HOVER_FIX.md
│   ├── SIDEBAR_FIXES.md
│   ├── SIDE_PANEL_FIX.md
│   └── TABLE_FINAL_FIXES.md
│
├── summaries/                  # Project Summaries (5 files)
│   ├── CHANGES_SUMMARY.md
│   ├── FINAL_FILTER_UPDATE_SUMMARY.md
│   ├── FLOW3_IMPLEMENTATION_SUMMARY.md
│   ├── QUICK_FIX_SUMMARY.md
│   └── REFACTORING_SUMMARY.md
│
├── troubleshooting/           # Troubleshooting (2 files)
│   ├── CSS_CONFLICT_TEST_REPORT.md
│   └── RESEND_TEST_MODE_ISSUE.md
│
├── deployment/                # Deployment Docs (2 files)
│   ├── PRODUCTION_READY.md
│   └── START_EMAIL_SERVER.md
│
└── templates/                 # Empty - reserved for future use

📊 Statistics

  • Total Documentation Files: 107+
  • Total Categories: 8 main categories
  • Feature Modules: 7 feature areas
  • Largest Category: Features (64 files)
    • Email Builder: 18 files
    • Authentication: 17 files
    • Abstracts: 11 files

🎯 Quick Navigation

By Size (Most Documentation)

  1. Email Builder (18 files) - /features/email-builder/
  2. UI Components (18 files) - /ui-components/
  3. Authentication (17 files) - /features/authentication/
  4. Abstracts (11 files) - /features/abstracts/
  5. Accommodation (7 files) - /features/accommodation/

By Type

  • Feature Docs: 64 files across 7 modules
  • UI Components: 18 files
  • Fixes: 7 files
  • Guides: 6 files
  • Summaries: 5 files
  • Troubleshooting: 2 files
  • Deployment: 2 files
  • Implementations: 2 files

🔍 Finding Documents

For Specific Features

Abstract Portal     → docs/features/abstracts/
Email Builder       → docs/features/email-builder/
Authentication      → docs/features/authentication/
Attendee Management → docs/features/attendees/
Accommodation       → docs/features/accommodation/
Coupons            → docs/features/coupons/
Tickets            → docs/features/tickets/

For Specific Tasks

Building UI         → docs/ui-components/
Fixing Bugs        → docs/fixes/
Troubleshooting    → docs/troubleshooting/
Deploying          → docs/deployment/
Quick Reference    → docs/guides/
Overview           → docs/summaries/

📝 Naming Conventions

All documentation files follow these patterns:

  • FEATURE_NAME_*.md - Feature-specific docs
  • *_GUIDE.md - Step-by-step guides
  • *_SUMMARY.md - High-level summaries
  • *_IMPLEMENTATION.md - Technical implementations
  • *_FIX.md or *_FIXES.md - Bug fixes
  • *_QUICK_REFERENCE.md - Quick reference cards
  • *_TESTING_GUIDE.md - Testing documentation

Structure Version: 1.0
Last Updated: January 2026