README.md

Documentation Index

Welcome to the Vibecode Blueprint documentation.

📚 Documentation Structure

Quick Start

• README.md - Main project overview and quick start
• PROJECT_OVERVIEW.md - Complete project overview, objectives, and goals
• PROJECT_STRUCTURE.md - Complete directory structure guide
• TECHNOLOGY_STACK.md - Technology stack, dependencies, and setup

Architecture

• architecture/ - System design and architecture documentation
  • SYSTEM_ARCHITECTURE.md** - Complete system architecture (Blueprint + Generated Projects)

Implementation Plans

• MCP_MEMORY_IMPLEMENTATION.md - Universal MCP Memory Server implementation plan

Guides

• guides/ - Operational guides and procedures
  • CONTRIBUTING.md - How to contribute to the project
  • ONBOARDING.md - New team member onboarding guide
  • WINDSURF_TEAM_COLLABORATION.md - Windsurf collaboration guide
  • PRE_COMMIT.md - Pre-commit hooks setup and usage
  • DOCUMENTATION_STANDARDS.md - Documentation best practices and standards

🎯 Documentation by Role

For New Team Members

1. Start with README.md
2. Read guides/ONBOARDING.md
3. Review architecture/SYSTEM_ARCHITECTURE.md
4. Follow guides/CONTRIBUTING.md

For Developers

1. guides/CONTRIBUTING.md - Development workflow
2. guides/PRE_COMMIT.md - Local validation setup
3. PROJECT_STRUCTURE.md - Repository organization
4. ../AGENTS.md - AI agent guidelines

For AI Agents

1. ../AGENTS.md - AI agent guidelines (comprehensive)
2. ../CLAUDE.md - Claude-specific guidance
3. guides/WINDSURF_TEAM_COLLABORATION.md - Windsurf collaboration

For Project Managers

1. README.md - Project overview
2. PROJECT_STRUCTURE.md - Repository organization
3. guides/CONTRIBUTING.md - Development workflow

For Documentation Authors

1. guides/DOCUMENTATION_STANDARDS.md - Documentation best practices
2. PROJECT_STRUCTURE.md - Repository organization
3. guides/CONTRIBUTING.md - Contribution workflow

📖 Documentation Standards

IMPORTANT: To prevent duplicate information and maintain consistency, always follow the Single Source of Truth principle.

Key Rules

• Link, Don't Duplicate - Reference information, don't copy it
• Use SCREAMING_SNAKE_CASE.md for file naming
• One Topic, One Document - Each document is authoritative for its topic
• Cross-Reference Liberally - Link to related documentation

For complete documentation standards and best practices, see guides/DOCUMENTATION_STANDARDS.md.

🔗 External Resources

• Vibecode Concept: AI-assisted collaborative development
• Windsurf: https://codeium.com/windsurf
• Roo Code: https://roosoft.io/
• KiloCode: https://kilocode.ai/
• Cline: https://docs.cline.bot/

🛠️ Quick Commands

# View all available commands
make help

# Install dependencies
make install

# Run setup
make setup

# Validate everything
make validate

# Install pre-commit hooks
make pre-commit-install

---

Last Updated: 2025-10-01 Maintained By: Development Team