Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# HelpMe-CLI Documentation

Welcome to the comprehensive documentation for HelpMe-CLI - an AI-powered CLI assistant for developers.

## 📋 Document Index

### Core Specifications
- [Product Requirements Document (PRD)](specifications/01_PRD_Product_Requirements.md) - Vision, goals, and success metrics
- [Technical Architecture](specifications/02_Technical_Architecture.md) - System design and implementation approach
- [Use Case Scenarios](specifications/03_Use_Case_Scenarios.md) - User journeys and interaction patterns
- [Responsible AI Framework](specifications/05_Responsible_AI_Framework.md) - Ethics and safety principles

### Implementation Guides
- [Implementation Roadmap](implementation/06_Implementation_Roadmap.md) - Development phases and practical next steps

## 🚀 Quick Start for Contributors
1. Read the [PRD](specifications/01_PRD_Product_Requirements.md) for project vision
2. Review [Use Case Scenarios](specifications/03_Use_Case_Scenarios.md) for user context
3. Check [Technical Architecture](specifications/02_Technical_Architecture.md) for system design
4. See [Implementation Roadmap](implementation/06_Implementation_Roadmap.md) for development priorities

## 🏗️ Current Implementation
This documentation builds on the existing Node.js + Genkit + Ink foundation. See the [Technical Architecture](specifications/02_Technical_Architecture.md) for details on how we enhance rather than replace the current working MVP.

## 🤝 Contributing
We welcome contributions! This documentation provides the foundation for:
- Understanding user needs and use cases
- Technical implementation decisions
- Responsible AI development practices
- Community contribution guidelines

---
*Documentation maintained as living specifications. Last updated: September 2025*
Loading
Loading