index.md

ThreeDoors Project Documentation Index

Project Overview

• Type: Monolith CLI/TUI Application
• Primary Language: Go 1.25.4
• Architecture: Model-View-Update (MVU) via Bubbletea
• Status: Technical Demo & Validation (Epic 1) — planning complete, source code not yet on main

Quick Reference

• Tech Stack: Go 1.25.4 + Bubbletea 1.2.4 + Lipgloss 1.0.0 + YAML storage
• Entry Point: cmd/threedoors/main.go (planned)
• Architecture Pattern: Two-layer monolith (TUI + Domain), MVU pattern
• Data: Local YAML files at ~/.threedoors/

Generated Documentation

• Project Overview — Project summary, status, roadmap
• Architecture Summary — Consolidated architecture overview
• Source Tree Analysis — Directory structure and critical folders
• Technology Stack — Full technology table
• Development Guide — Prerequisites, build, test, coding standards
• Project Structure — Classification and legacy artifact inventory
• Comprehensive Analysis — Component and data model analysis
• Existing Documentation Inventory — Catalog of all docs found

Existing Documentation (BMAD v4 Artifacts)

Product & Requirements

• Product Brief — Executive product brief with vision and scope
• PRD (index) — Product Requirements Document (10 sharded files)
  • Goals & Background
  • Requirements
  • UI Design Goals
  • Technical Assumptions
  • Epic List
  • Epic Details
  • Checklist Results
  • Next Steps
  • Appendix: Story Optimization

Architecture (Detailed)

• Architecture Index — Full sharded architecture (19 files)
  • Introduction
  • High-Level Architecture
  • Tech Stack
  • Components
  • Core Workflows
  • Data Models
  • Data Storage Schema
  • Source Tree
  • Coding Standards
  • Test Strategy
  • Error Handling
  • Security
  • External APIs
  • REST API Spec
  • Infrastructure & Deployment
  • Checklist Results
  • Next Steps

Stories & Implementation

• Story 1.1: Project Setup & Basic Bubbletea App — Completed
• Story 1.2: Display Three Doors from Task File — Completed
• QA Gate 1.1 — Story 1.1 QA gate

Process & Tracking

• BMM Workflow Status — BMAD v4 workflow tracking
• Brainstorming Results — Initial brainstorming session
• Deliverables Summary — Summary of all deliverables
• Changelog — Nov 7-11 2025 changes
• Validation Decision Rubric — Decision rubric

Archive

• Archive README — Archive description
• Monolithic PRD (Nov 7, 2025) — Pre-sharding version
• Monolithic Architecture (Nov 7, 2025) — Pre-sharding version

Getting Started

1. Ensure Go 1.25.4+ is installed (go version)
2. Clone: git clone https://github.com/arcavenae/ThreeDoors.git
3. Build: make build (once source code is committed)
4. Run: make run or ./bin/threedoors
5. Read the Development Guide for coding standards and testing

For AI-Assisted Development

When creating a brownfield PRD or planning new features, point your workflow to this index.md as the primary context source. Key files for AI context:

1. This index — Navigation map
2. Architecture Summary — Quick architectural understanding
3. PRD — Full requirements and epic details
4. Development Guide — Coding standards and patterns
5. Components — Detailed component specifications