DOCUMENTATION.md

Linear Buddy Documentation

Welcome to the Linear Buddy documentation! This guide will help you find the right documentation for your needs.

---

📚 Quick Links

For...	Go to...
Users	User Guides →
Features	Feature Documentation →
Developers	Developer Docs →
Planning	Roadmap & Plans →

---

🎯 I want to...

Get Started

• Just installed? → Quick Start Guide
• Need help? → User Guide
• Want examples? → Usage Guide

Learn About Features

• AI Features → AI Documentation
• Branch Management → Branch Features
• Ticket Management → Ticket Features
• TODO Converter → TODO Converter ⭐ (NEW!)
• PR & Standup → PR & Standup Features

Develop or Contribute

• Set up development → Developer Guide
• Run tests → Testing Guide
• Debug issues → Debug Guide
• Build webviews → Webview Guide

Understand the Roadmap

• Multi-platform plan → Sprint Plan
• Feature ideas → Ideas

---

📁 Documentation Structure

docs/
├── user-guides/          # For users
│   ├── QUICKSTART.md
│   ├── LINEAR_BUDDY_GUIDE.md
│   ├── USAGE.md
│   └── ...
│
├── features/             # Feature documentation
│   ├── ai/              # AI features (standups, PR summaries)
│   ├── branches/        # Branch management
│   ├── tickets/         # Ticket creation & management
│   ├── todo-converter/  # TODO → Ticket conversion ⭐
│   └── pr-standup/      # PR & Standup features
│
├── developer/           # For developers
│   ├── TESTING.md
│   ├── DEBUG_QUICK_START.md
│   ├── WEBVIEW_GUIDE.md
│   └── ...
│
├── planning/            # Roadmap & planning
│   ├── SPRINT_PLAN_MULTI_PLATFORM.md
│   └── IDEAS.md
│
└── archive/             # Historical docs
    └── old implementations

---

⭐ What's New

TODO Converter Features (November 2025)

• Automatic Permalinks - GitHub/GitLab/Bitbucket links
• "Add More TODOs" Workflow - Navigate & paste workflow
• Link Multiple TODOs - Bulk link existing TODOs

---

🚀 Popular Guides

Guide	Description	Link
Quick Start	Get up and running in 5 minutes	View →
TODO Converter	Turn TODOs into tickets with permalinks	View →
Multi-Ticket	Work across multiple tickets	View →
AI Features	Configure AI models & features	View →
Sprint Plan	Multi-platform roadmap	View →

---

🎓 Learning Path

For New Users

1. Quick Start - 5 minutes
2. User Guide - 15 minutes
3. TODO Converter - 10 minutes
4. Usage Examples - As needed

For Developers

1. Developer Setup - 30 minutes
2. Architecture Overview - 20 minutes
3. Testing Guide - 15 minutes
4. Sprint Plan - Understanding roadmap

---

🤔 Need Help?

• Bug or issue? → Open an issue
• Question? → Check User Guide
• Feature request? → See Ideas

---

📋 Reorganization Info

Documentation was reorganized in November 2025 to improve clarity and navigation.

• Old location: 57 .md files in root directory
• New location: Organized in docs/ by audience and purpose
• Archive: Historical docs moved to docs/archive/

See Organization Guide for details.

---

Version: 1.0
Last Updated: November 2025
Status: ✅ Production Ready