Add comprehensive documentation structure

thegdsks · thegdsks · commit ca35b64336c5 · 2025-08-09T00:11:31.000-05:00
- Add docs/index.md with CommitWeave overview and features
- Add docs/installation.md with setup and configuration guide
- Add docs/usage.md with examples and CLI reference
- Add docs/api/reference.md with complete API documentation
- Include proper MDX frontmatter for typeweaver-docs integration
- Cover AI-powered commit generation, configuration, and usage

🤖 Generated with GLINR Studios
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,100 @@
+---
+title: "CommitWeave Documentation"
+description: "AI-powered Git commit message generation tool for beautiful, conventional commits"
+order: 1
+---
+
+# CommitWeave
+
+CommitWeave is an intelligent CLI tool that helps you create beautiful, structured, and conventional Git commit messages with AI-powered assistance. Transform your Git workflow with smart commit message generation that follows industry standards and best practices.
+
+## What is CommitWeave?
+
+CommitWeave combines the power of AI with conventional commit standards to create an exceptional Git workflow experience. Whether you're working solo or with a team, CommitWeave ensures your commit history is clean, meaningful, and professional.
+
+### Key Features
+
+- **🤖 AI-Powered Generation**: Leverages OpenAI GPT and Anthropic Claude to analyze your changes and generate contextual commit messages
+- **📝 Conventional Commits**: Full support for conventional commit format with predefined types and scopes
+- **🎨 Beautiful CLI Interface**: Interactive prompts with animations, colors, and branded styling
+- **✨ Smart Emoji Integration**: Contextual emojis that make your commit history visually appealing
+- **⚙️ Highly Configurable**: Customize everything from commit types to AI models
+- **🔧 Git Integration**: Seamless integration with your existing Git workflow
+- **✅ Validation**: Built-in commit message validation and formatting
+
+## Quick Start
+
+Get up and running with CommitWeave in minutes:
+
+```bash
+# Install globally
+npm install -g commitweave
+
+# Initialize configuration
+commitweave init
+
+# Create your first AI-powered commit
+commitweave --ai
+```
+
+## Why CommitWeave?
+
+### Before CommitWeave
+```
+git commit -m "fix stuff"
+git commit -m "update"
+git commit -m "changes"
+```
+
+### After CommitWeave
+```
+feat(auth): ✨ implement JWT token validation system
+
+Add comprehensive JWT authentication with automatic token
+refresh and secure session management.
+
+BREAKING CHANGE: Legacy auth endpoints deprecated
+```
+
+## Core Principles
+
+1. **🎨 Beauty First** - Every interaction should be visually appealing
+2. **⚡ Speed Matters** - Fast, responsive, and efficient operations  
+3. **🛡️ Type Safety** - Full TypeScript coverage for reliability
+4. **🔧 Configurable** - Highly customizable to fit team preferences
+5. **🤖 AI-Enhanced** - Smart assistance without complexity
+6. **📝 Standards-Based** - Full conventional commit compliance
+
+## Supported Commit Types
+
+CommitWeave includes 11 predefined conventional commit types:
+
+| Type | Emoji | Description |
+|------|--------|-------------|
+| `feat` | ✨ | A new feature |
+| `fix` | 🐛 | A bug fix |
+| `docs` | 📚 | Documentation changes |
+| `style` | 💎 | Code style changes (formatting) |
+| `refactor` | 📦 | Code refactoring |
+| `perf` | 🚀 | Performance improvements |
+| `test` | 🚨 | Adding or correcting tests |
+| `build` | 🛠 | Build system or external dependencies |
+| `ci` | ⚙️ | CI configuration changes |
+| `chore` | ♻️ | Maintenance tasks |
+| `revert` | 🗑 | Revert previous commit |
+
+## Getting Started
+
+Ready to transform your Git workflow? Check out our comprehensive guides:
+
+- [Installation Guide](./installation.md) - Get CommitWeave installed on your system
+- [Usage Examples](./usage.md) - Learn how to use CommitWeave effectively
+- [API Reference](./api/reference.md) - Detailed API documentation
+
+## Community and Support
+
+CommitWeave is built by the GLINR team and published by @typeweaver. Join our community for support, feature requests, and contributions.
+
+---
+
+*Transform your Git workflow with intelligent, beautiful commit messages.*
diff --git a/docs/installation.md b/docs/installation.md
@@ -0,0 +1,287 @@
+---
+title: "Installation Guide"
+description: "Complete guide to installing CommitWeave on your system"
+order: 2
+---
+
+# Installation Guide
+
+This guide will walk you through installing CommitWeave on your system and getting it configured for your development workflow.
+
+## Prerequisites
+
+Before installing CommitWeave, ensure you have:
+
+- **Node.js 18.0.0 or higher** - CommitWeave requires modern Node.js features
+- **Git** - CommitWeave integrates with your Git workflow
+- **NPM or Yarn** - For package management
+
+You can verify your Node.js version:
+```bash
+node --version
+```
+
+## Installation Methods
+
+### Method 1: Global NPM Installation (Recommended)
+
+Install CommitWeave globally for use across all your projects:
+
+```bash
+npm install -g commitweave
+```
+
+Verify the installation:
+```bash
+commitweave --version
+```
+
+### Method 2: Local Project Installation
+
+Install CommitWeave as a development dependency in your project:
+
+```bash
+# Using npm
+npm install --save-dev commitweave
+
+# Using yarn
+yarn add -D commitweave
+
+# Using pnpm
+pnpm add -D commitweave
+```
+
+Add a script to your `package.json`:
+```json
+{
+  "scripts": {
+    "commit": "commitweave"
+  }
+}
+```
+
+Then run with:
+```bash
+npm run commit
+```
+
+### Method 3: Using npx (No Installation)
+
+Run CommitWeave directly without installing:
+
+```bash
+npx commitweave
+```
+
+## Initial Setup
+
+### 1. Initialize Configuration
+
+After installation, set up CommitWeave for your project:
+
+```bash
+commitweave init
+```
+
+This creates a `glinr-commit.json` configuration file with sensible defaults:
+
+```json
+{
+  "commitTypes": [
+    {
+      "type": "feat",
+      "description": "A new feature",
+      "emoji": "✨"
+    },
+    {
+      "type": "fix", 
+      "description": "A bug fix",
+      "emoji": "🐛"
+    }
+    // ... more types
+  ],
+  "emojiEnabled": true,
+  "conventionalCommits": true,
+  "maxSubjectLength": 50,
+  "ui": {
+    "fancyUI": true,
+    "asciiArt": true,
+    "animations": true,
+    "colors": true,
+    "emoji": true
+  }
+}
+```
+
+### 2. Configure AI Providers (Optional)
+
+To use AI-powered commit generation, you'll need to configure an AI provider.
+
+#### OpenAI Setup
+
+1. Get an API key from [OpenAI Platform](https://platform.openai.com/api-keys)
+2. Configure CommitWeave:
+
+```bash
+# Set your API key
+export OPENAI_API_KEY="your-api-key-here"
+
+# Or add to your shell profile (.bashrc, .zshrc, etc.)
+echo 'export OPENAI_API_KEY="your-api-key-here"' >> ~/.zshrc
+```
+
+3. Update your configuration:
+
+```json
+{
+  "ai": {
+    "provider": "openai",
+    "model": "gpt-3.5-turbo",
+    "temperature": 0.7,
+    "maxTokens": 150
+  }
+}
+```
+
+#### Anthropic Claude Setup
+
+1. Get an API key from [Anthropic Console](https://console.anthropic.com/)
+2. Configure CommitWeave:
+
+```bash
+# Set your API key
+export ANTHROPIC_API_KEY="your-api-key-here"
+```
+
+3. Update your configuration:
+
+```json
+{
+  "ai": {
+    "provider": "anthropic",
+    "model": "claude-3-sonnet-20240229",
+    "temperature": 0.7,
+    "maxTokens": 150
+  }
+}
+```
+
+## Verification
+
+Test your installation with these commands:
+
+```bash
+# Check version
+commitweave --version
+
+# Validate configuration
+commitweave doctor
+
+# Test basic functionality
+commitweave --help
+
+# Test AI functionality (if configured)
+commitweave --ai
+```
+
+## Platform-Specific Notes
+
+### Windows
+
+CommitWeave works on Windows with Command Prompt, PowerShell, and Git Bash. For the best experience:
+
+1. Use Windows Terminal for enhanced colors and emoji support
+2. Ensure your terminal supports Unicode for proper emoji display
+3. Consider using Git Bash for a Unix-like experience
+
+### macOS
+
+CommitWeave works out of the box on macOS. For enhanced terminal experience:
+
+1. Use iTerm2 or the built-in Terminal app
+2. Install a Nerd Font for better emoji and icon support
+3. Enable "Use Unicode UTF-8" in Terminal preferences
+
+### Linux
+
+CommitWeave works on all major Linux distributions:
+
+1. Ensure your terminal supports Unicode
+2. Install font packages for emoji support:
+   ```bash
+   # Ubuntu/Debian
+   sudo apt install fonts-noto-color-emoji
+   
+   # Arch Linux
+   sudo pacman -S noto-fonts-emoji
+   ```
+
+## Configuration Management
+
+### Global vs Project Configuration
+
+CommitWeave supports both global and project-specific configurations:
+
+- **Global**: `~/.config/commitweave/glinr-commit.json`
+- **Project**: `./glinr-commit.json` (takes precedence)
+
+### Environment Variables
+
+CommitWeave respects these environment variables:
+
+```bash
+# API Keys
+OPENAI_API_KEY=""
+ANTHROPIC_API_KEY=""
+
+# Configuration overrides
+COMMITWEAVE_EMOJI_ENABLED="true"
+COMMITWEAVE_AI_PROVIDER="openai"
+COMMITWEAVE_MAX_SUBJECT_LENGTH="50"
+```
+
+## Troubleshooting
+
+### Common Issues
+
+#### "Command not found"
+- Ensure Node.js and npm are installed
+- Check if global npm bin directory is in your PATH
+- Try reinstalling: `npm uninstall -g commitweave && npm install -g commitweave`
+
+#### "Permission denied"
+- Use `sudo` for global installation: `sudo npm install -g commitweave`
+- Or configure npm to use a different directory for global packages
+
+#### AI features not working
+- Verify your API key is set correctly
+- Check your internet connection
+- Ensure you have API credits available
+- Run `commitweave doctor` for diagnostics
+
+#### Unicode/Emoji display issues
+- Ensure your terminal supports Unicode
+- Install appropriate font packages
+- Check terminal encoding settings
+
+### Getting Help
+
+If you encounter issues:
+
+1. Run `commitweave doctor` for health checks
+2. Check the configuration with `commitweave list`
+3. Review the logs for error messages
+4. Visit our GitHub repository for support
+
+## Next Steps
+
+Now that CommitWeave is installed and configured:
+
+1. [Learn basic usage patterns](./usage.md)
+2. [Explore the API reference](./api/reference.md)
+3. Customize your configuration for your team's needs
+4. Set up AI providers for intelligent commit generation
+
+---
+
+*Ready to create beautiful commits? Let's get started!*
diff --git a/docs/usage.md b/docs/usage.md
