Index

File: docs/INDEX.md
Purpose: Project documentation index and quick start guide

📚 Table of Contents

Project Overview

• README.md - Main project documentation, architecture, and quick start guide

Design & Architecture

• DESIGN.md - Typography, color palette, spacing, and design principles
• BRAND.md - Brand identity, voice, and visual guidelines
• CURRENCY_ARCHITECTURE.md - Multi-currency conversion system architecture and algorithms
• PORTFOLIO_TEMPLATE.md - Portfolio piece explaining project purpose and technical decisions

Development Process

• LESSONS_LEARNED.md - Strategic decisions, bugs encountered, and how we fixed them
• AI_ENGINEERING_RULES.md - Platform-agnostic AI collaboration guidelines and engineering principles
• AI_STARTUP.md - Quick AI assistant onboarding and communication protocols
• SKILL-WORKING-WITH-HUMANS.md - Human-AI collaboration patterns and best practices

Planning & Roadmap

• PRD.md - Product Requirements Document
• ROADMAP.md - Project roadmap and feature planning

Deployment & Operations

• PREDEPLOY_AUDIT.md - Pre-deployment verification checklist

Templates & References

• PORTFOLIO_TEMPLATE.md - Formal portfolio entry template with examples and guidelines

📖 How to Use This Documentation

For Developers:

1. Start with README.md for architecture overview
2. Review DESIGN.md for design constraints
3. Check LESSONS_LEARNED.md to avoid known pitfalls

For Portfolio Reviewers:

1. Read PORTFOLIO_TEMPLATE.md for project context
2. Review PRD.md for product requirements
3. See LESSONS_LEARNED.md for problem-solving approach

For AI Collaborators:

1. Review AI_ENGINEERING_RULES.md for coding standards
2. Read SKILL-WORKING-WITH-HUMANS.md for collaboration patterns

🔗 Quick Links

• Live Site: freelance-income-planner.vercel.app (if deployed)
• Repository: GitHub
• License: MIT License

📝 Documentation Standards

All documentation files in this directory follow these conventions:

1. File Header: Each file includes its filename and purpose at the top
2. Markdown Formatting: Consistent use of headers, lists, and code blocks
3. Skimmable Structure: Clear sections with emoji headers for quick navigation
4. Practical Focus: Emphasis on actionable information over theory

Last Updated: January 6, 2026
Documentation Version: 1.0.0