Skip to content

Latest commit

 

History

History
111 lines (83 loc) · 4.77 KB

File metadata and controls

111 lines (83 loc) · 4.77 KB

TaskGenie Documentation Index

Naming Conventions

  • CLI binary: tgenie (interactive TUI planned; CLI scaffolding exists today)
  • Scripting: tgenie <command> (e.g., tgenie add, tgenie list)
  • Optional: add a shell alias (user preference), e.g. alias tg=tgenie or alias taskgenie=tgenie

Quick Start

New to the project? Start here:

  1. Read Developer Quickstart for a 5-minute run-through
  2. Read Setup Guide for installation and configuration
  3. Explore Research Phase to understand project vision
  4. Review Design Phase for technical specifications
  5. Follow Implementation Plans for development roadmap

Document Categories

Market research, competitor analysis, and gap identification.

Technical design specifications and architecture decisions.

Implementation plans, pull request tracking, and development roadmap.

  • PR-PLANS.md - START HERE - Detailed PR plan with roadmap
  • pr-specs/INDEX.md - Specs + test scenarios for each PR
  • PR specs include a "Docs Links" section pointing to the living docs (README + core guides)
  • PLAN.md - Original project plan (condensed; Q&A archived)
  • PLAN_ARCHIVE.md - Archived planning Q&A / early questions
  • TESTING_GUIDE.md - Testing policy and examples

Quick Links

Setup

Architecture

API Design

Development

  • Agent Guide - AI agents & developers: Code patterns, conventions, and learnings ⭐ NEW
  • PR Plans - Implementation roadmap
  • Testing Guide - Testing policy and examples

Status

  • Project Status: Phase 1 - Infrastructure Setup
  • Documentation Status: Spec Complete (Implementation In Progress)
  • Last Reviewed: 2025-12-30
  • Next Step: Review PR plans and begin implementation

Note: Documentation reflects design specifications. Implementation status tracked in PR-PLANS.md.


For Contributors

  1. Read PR Plans before starting work
  2. Pick a PR from the list
  3. Create feature branch from main
  4. Implement according to design documents
  5. Include tests
  6. Update status in PR-PLANS.md
  7. Submit PR with clear description

Project Stats

  • Total Planned PRs: See PR-PLANS.md for current count
  • Estimated Effort: ~130 hours (~16 weeks for one developer)
  • Current Status: Planning phase complete, ready to implement