Skip to content

DOCS_INDEX.md

Latest commit

 

History

History
194 lines (151 loc) · 6.4 KB

DOCS_INDEX.md

File metadata and controls

194 lines (151 loc) · 6.4 KB
Raw

📚 Documentation Index

Start here to find what you need!

🎯 If You Want To...

🚀 Get Started (First Time?)

  1. Read: README.md - Complete guide (start here!)
  2. Run: pnpm dev
  3. Test: Add a repository via the "+" button

🤔 Understand the Project

  • README.md (📍 START HERE) - Complete overview in one place
    • What the app does
    • How to use it
    • Installation
    • Troubleshooting
    • Everything for users & developers

💻 Develop or Contribute

  1. README.md - Architecture section
  2. docs/IMPLEMENTATION.md - Technical implementation details
  3. docs/planner.md - Original vision and design decisions
  4. Source code in src/ folder with inline comments

🐛 Debug an Issue

  1. README.md - Troubleshooting section (covers 90% of issues)
  2. docs/BUGFIXES.md - Known issues and their solutions
  3. Console errors - Check browser dev tools (F12)

🔗 Integrate with Git

  • README.md - How the app works section
  • docs/planner.md - Architecture details

🤖 Setup AI Providers

  • README.md - "Setting Up AI Providers" section (all 6+ options explained)

🏗️ Understand Architecture

  1. README.md - Architecture overview
  2. docs/IMPLEMENTATION.md - Detailed architecture
  3. docs/planner.md - Original design vision

📦 Build & Deploy

  • README.md - Deployment section

📄 Quick Reference: Each File

File Purpose Read If...
README.md 📍 MAIN GUIDE Complete user & developer guide This is the only file most people need
docs/IMPLEMENTATION.md Technical status & roadmap You're a developer or want technical details
docs/planner.md Original architecture & vision You want to understand design decisions
docs/BUGFIXES.md Known issues & solutions You found a bug or error
docs/CLI.md gitxplain CLI integration You're integrating the CLI tool
docs/SUMMARY.md Status overview (older) You want implementation progress details
docs/QUICKSTART.md Quick implementation guide (older) You want step-by-step setup
docs/TESTING.md Testing procedures You want to test the app

🗺️ File Structure

Root (You are here)
│
├── 📖 README.md ⭐
│   └── THE MAIN FILE - Everything is here!
│
├── 🤖 DOCS_INDEX.md
│   └── This file - helps you navigate
│
├── 📁 docs/ (All other documentation)
│   ├── IMPLEMENTATION.md      - Technical details
│   ├── planner.md             - Original vision
│   ├── BUGFIXES.md            - Known issues
│   ├── CLI.md                 - CLI integration
│   ├── SUMMARY.md             - Status summary
│   ├── QUICKSTART.md          - Quick setup
│   ├── TESTING.md             - Testing guide
│   └── (other reference docs)
│
├── 📁 src/
│   ├── services/          ← Core logic (git, AI, grouping)
│   ├── pages/             ← The 5 tabs (UI)
│   ├── components/        ← Shared components
│   ├── main/              ← Electron main process (IPC)
│   └── store/             ← State management
│
└── 📦 Build Files
    ├── package.json
    ├── tsconfig.json
    ├── webpack.*.js
    └── electron-builder.yml

🚦 Three Reading Paths

👤 Path 1: I Just Want to Use It

  1. README.md - Quick Start section (2 mins)
  2. README.md - "How to Use" section (5 mins)
  3. README.md - "Setting Up AI Providers" (5 mins)
  4. Start using! 🎉

Total Time: ~15 minutes

👨‍💼 Path 2: I Want to Understand It

  1. README.md - Everything (15-20 mins)
  2. docs/IMPLEMENTATION.md - Architecture section (if curious)
  3. Done! 🎓

Total Time: ~20 minutes

👨‍💻 Path 3: I Want to Develop/Contribute

  1. README.md - Complete read (20 mins)
  2. docs/IMPLEMENTATION.md - Technical details (10 mins)
  3. docs/planner.md - Design vision (10 mins)
  4. Read relevant src/ files with comments (varies)
  5. Start coding! 💻

Total Time: ~1-2 hours

❓ FAQ About Documentation

Q: Which file should I read first?

A: README.md - It's the master file with everything.

Q: I don't have time to read long docs

A: Start with README.md's Quick Start section (2 minutes)

Q: I found a bug, what do I do?

A:

  1. Check README.md Troubleshooting section
  2. Check docs/BUGFIXES.md
  3. If not there, I need details for debugging

Q: Where is the main code?

A: src/ directory. Key files:

  • src/main/index.ts - IPC & electron magic
  • src/services/gitService.ts - Git operations
  • src/services/aiService.ts - AI interactions
  • src/pages/ - The 5 main tabs

Q: Can I modify the docs?

A: Yes! But keep README.md as the master source.

Q: Why are there so many docs?

A: Historical - as the project evolved, docs accumulated. README.md consolidates everything. Other docs are in /docs/ for reference.

👉 Next Steps

  1. If you haven't started yet:

    • Read README.md Quick Start section
    • Run pnpm dev
    • Test with a repository

  2. If you have questions:

  3. If you want to contribute:

📞 Quick Links

Need Link
Installation README.md#installation
Quick Start README.md#quick-start
How to Use README.md#how-to-use
FAQ README.md#faq
Troubleshooting README.md#troubleshooting
AI Setup README.md#setting-up-ai-providers
Architecture README.md#architecture-overview
Development README.md#development
Deployment README.md#deployment

TL;DR: Read README.md. That's it. Everything you need is there. Want reference docs? Check docs/ folder. 📖