Skip to content

Latest commit

 

History

History
155 lines (124 loc) · 4.38 KB

INDEX.md

File metadata and controls

155 lines (124 loc) · 4.38 KB

Documentation Index

This directory contains all project documentation organized by category for easy reference by developers, AI agents, and LLMs.

📁 Directory Structure

/features - Feature Documentation

Feature-specific documentation organized by module:

/features/abstracts - Abstract Submission Portal

  • Complete implementation guides for the abstract submission system
  • Portal layout, sidebar, and page designs
  • Testing guides and visual references

/features/authentication - Authentication System

  • Login, signup, and password reset flows
  • Form updates and UI improvements
  • Quick reference guides

/features/email-builder - Email Builder & Templates

  • Email builder implementation and components
  • Maily integration guides
  • Email templates (Professional, Welcome, Tech Summit)
  • Drag & drop functionality
  • Settings sidebar and compact design

/features/accommodation - Accommodation Management

  • Accommodation feature implementation
  • UI guides and flow diagrams
  • Menu structure and checklists

/features/attendees - Attendee Management

  • Attendee pages and check-in implementation
  • Filter bar updates
  • Manage attendees functionality

/features/coupons - Coupon & Discount System

  • Coupon redesign documentation
  • Promo and discount table updates

/features/tickets - Ticket Portal

  • Ticket portal enhancements and features

/features (root level)

  • Additional info sections
  • Analytics menu additions
  • CC email feature
  • Import users feature

/guides - User & Developer Guides

Step-by-step guides and quick references:

  • Deployment guides
  • Filter bar guides
  • Image replacement guides
  • Quick start guides
  • Testing guides
  • Visual guides

/implementations - Implementation Details

Technical implementation documentation:

  • Flow implementations (Flow2, Flow3)
  • Feature implementation summaries
  • Integration details

/fixes - Bug Fixes & Patches

Documentation of bug fixes and patches:

  • Component fixes
  • UI fixes
  • Template fixes
  • Sidebar fixes

/summaries - Project Summaries

High-level summaries and overviews:

  • Feature summaries
  • Implementation summaries
  • Update summaries
  • Refactoring summaries

/ui-components - UI Component Documentation

Reusable UI component documentation:

  • Sidebar components
  • Filter components
  • Table components
  • Modal components
  • Compact UI updates
  • Shimmer loading
  • Column sorting
  • Pagination

/troubleshooting - Troubleshooting Guides

Problem-solving documentation:

  • CSS conflict reports
  • Test mode issues
  • Common problems and solutions

/deployment - Deployment Documentation

Production deployment guides:

  • Production readiness checklist
  • Email server setup
  • Deployment procedures

🔍 How to Use This Documentation

For Developers

  1. Start with feature-specific docs in /features for implementation details
  2. Check /guides for step-by-step instructions
  3. Reference /ui-components for reusable component patterns
  4. Use /troubleshooting when encountering issues

For AI Agents & LLMs

  1. Use this INDEX.md to understand the documentation structure
  2. Reference specific feature folders when working on related tasks
  3. Check /summaries for quick overviews
  4. Use /implementations for technical implementation patterns

For Project Managers

  1. Review /summaries for high-level feature overviews
  2. Check /features for detailed feature documentation
  3. Reference /deployment for production readiness

📝 Documentation Standards

All documentation files follow these conventions:

  • Clear, descriptive filenames
  • Organized by feature/topic
  • Include implementation details where relevant
  • Reference related files and components
  • Provide visual examples when applicable

🔄 Keeping Documentation Updated

When adding new documentation:

  1. Place it in the appropriate category folder
  2. Update this INDEX.md if adding new categories
  3. Use clear, descriptive filenames
  4. Follow existing documentation patterns
  5. Cross-reference related documents

📚 Quick Links

Most Referenced Documents

  • Abstract Portal: /features/abstracts/
  • Email Builder: /features/email-builder/
  • Authentication: /features/authentication/
  • UI Components: /ui-components/

Getting Started

  • Quick Start Guides: /guides/
  • Implementation Patterns: /implementations/
  • Feature Summaries: /summaries/

Last Updated: January 2026 Total Documents: 107+