Add comprehensive project documentation

[JeremyDev87]

Add Comprehensive Project Documentation

Summary

This PR adds comprehensive project documentation to help users understand Codingbuddy's purpose, get started quickly, and integrate with various AI coding assistants. This addresses issue #39.

Changes

New Documentation Files

1. README.md - Main project overview

   • Project introduction and value proposition
   • Quick start guide with installation steps
   • Supported AI tools overview
   • Documentation index
   • Architecture overview

2. docs/getting-started.md - Detailed setup guide (211 lines)

   • Prerequisites and installation steps
   • Configuration guide with examples
   • Workflow modes (PLAN → ACT → EVAL) usage
   • Specialist agents activation guide
   • Next steps and references

3. docs/philosophy.md - Design principles and vision (128 lines)

   • Project vision and core beliefs
   • Design principles (Single Source of Truth, Separation of Concerns, Extensibility)
   • Workflow model explanation
   • What Codingbuddy is not

4. docs/supported-tools.md - AI tool integration guides (230 lines)

   • Setup guides for 6 AI tools:
     • Claude Code (MCP Server)
     • Cursor (Rules Directory)
     • GitHub Copilot / Codex (Instructions File)
     • Antigravity (Config Directory)
     • Amazon Q (Rules Directory)
     • Kiro (Spec Directory)
   • Feature comparison table
   • Quick setup examples for each tool

Updates

• mcp-server/README.md - Fixed CI badge URL
  • Updated workflow name from ci.yml to dev.yml

Statistics

• 5 files changed
• 659 insertions, 1 deletion
• 4 new documentation files added
• 1 file updated (CI badge fix)

Related Issue

Closes #39

Documentation Structure

The new documentation follows a logical flow:

README.md (entry point)
├── Quick Start → docs/getting-started.md
├── Philosophy → docs/philosophy.md
├── Supported Tools → docs/supported-tools.md
└── Other docs (config-schema, api, development)

Key Features Documented

• ✅ Installation and setup process
• ✅ Configuration options and examples
• ✅ PLAN → ACT → EVAL workflow explanation
• ✅ Specialist agents usage
• ✅ Integration guides for 6 AI tools
• ✅ Project vision and design principles
• ✅ Architecture overview

Testing

• All markdown files render correctly
• Links between documents work properly
• Code examples are properly formatted
• CI badge URL updated correctly

Screenshots

N/A - Documentation only change

Notes

This documentation provides a solid foundation for new users and contributors to understand and use Codingbuddy effectively. The structure allows for easy expansion as the project grows.