# omni-dev Documentation

Complete documentation for omni-dev - the intelligent Git commit message toolkit with AI-powered contextual intelligence.

## 📚 User Documentation

### Getting Started

- **[README](../README.md)** - Quick overview and installation
- **[User Guide](user-guide.md)** - Comprehensive usage guide with examples
- **[Configuration Guide](configuration.md)** - Set up contextual intelligence
- **[Local Overrides](local-overrides.md)** - Personal configuration customization
- **[Configuration Best Practices](configuration-best-practices.md)** - Writing effective scopes and guidelines
- **[Examples](examples.md)** - Real-world usage examples across different project types

### Atlassian Integration

- **[User Guide - Atlassian](user-guide.md#atlassian---jira-and-confluence-integration)** - JIRA and Confluence commands
- **[JFM Specification](specs/jfm.md)** - JIRA-Flavored Markdown format and ADF conversion

### Reference & Support

- **[Troubleshooting](troubleshooting.md)** - Common issues and solutions  
- **[API Documentation](https://docs.rs/omni-dev)** - Rust API reference
- **[Changelog](../CHANGELOG.md)** - Version history and changes

## 🛠️ Developer Documentation

### Project Planning & Architecture

- **[Project Plan](plan/project.md)** - Technical architecture and implementation details
- **[Twiddle Design](plan/twiddle.md)** - Complete design for the twiddle command phases
- **[PR Creation](plan/pr-creation.md)** - Pull request creation workflow
- **[Help All Command](plan/help-all-command.md)** - Comprehensive help system design
- **[Config Internals](plan/config-internals.md)** - How configuration resolution works

### Retrospectives

- **[v0.18.0 Retrospective](retrospective-v0.18.0.md)** - ADR-guided code quality and issue-driven development

### Development & Release

- **[Contributing Guidelines](../CONTRIBUTING.md)** - How to contribute to the project
- **[Release Process](RELEASE.md)** - Complete release workflow and procedures

## 🚀 Quick Navigation

### I want to

**Get started quickly**
→ [README Quick Start](../README.md#-quick-start) → [30-Second Demo](../README.md#30-second-demo)

**Understand all features**  
→ [User Guide](user-guide.md) → [Core Commands](user-guide.md#command-reference)

**Set up my project**
→ [Configuration Guide](configuration.md) → [Project Configuration](configuration.md#setting-up-context)

**See real examples**
→ [Examples](examples.md) → [Your Project Type](examples.md#table-of-contents)

**Write better configuration**
→ [Best Practices](configuration-best-practices.md) → [Scope Guidelines](configuration-best-practices.md#writing-effective-scope-definitions)

**Fix a problem**
→ [Troubleshooting](troubleshooting.md) → [Common Solutions](troubleshooting.md#common-solutions-checklist)

**Contribute to the project**
→ [Contributing Guidelines](../CONTRIBUTING.md) → [Development Setup](../CONTRIBUTING.md#development-setup)

## 📖 Documentation Overview

### User Journey

1. **Discovery**: Start with [README](../README.md) for overview and quick installation
2. **Learning**: Follow [User Guide](user-guide.md) for comprehensive usage
3. **Setup**: Use [Configuration Guide](configuration.md) to set up your project
4. **Practice**: Try [Examples](examples.md) relevant to your project type
5. **Troubleshooting**: Reference [Troubleshooting](troubleshooting.md) when needed

### Key Features Covered

| Feature | Primary Documentation | Additional Resources |
|---------|----------------------|----------------------|
| **AI-Powered Twiddle** | [User Guide - Twiddle](user-guide.md#twiddle---ai-powered-improvement) | [Examples - Before/After](examples.md#beforeafter-showcases) |
| **Contextual Intelligence** | [Configuration Guide](configuration.md#contextual-intelligence) | [User Guide - Context](user-guide.md#contextual-intelligence) |
| **Project Configuration** | [Configuration Guide - Setup](configuration.md#setting-up-context) | [Examples - Configurations](examples.md#project-specific-examples) |
| **Local Overrides** | [Local Overrides Guide](local-overrides.md) | [Configuration - Local Setup](configuration.md#local-override-examples) |
| **Automatic Batching** | [User Guide - Batching](user-guide.md#automatic-batching) | [Troubleshooting - Performance](troubleshooting.md#performance-issues) |
| **Workflow Integration** | [User Guide - Workflows](user-guide.md#workflows) | [Examples - Enterprise](examples.md#enterprise-monorepo) |
| **Configuration Quality** | [Best Practices](configuration-best-practices.md) | [Config Internals](plan/config-internals.md) |
| **Atlassian Integration** | [User Guide - Atlassian](user-guide.md#atlassian---jira-and-confluence-integration) | [JFM Spec](specs/jfm.md) |

## 🔗 External Resources

- **[GitHub Repository](https://github.com/rust-works/omni-dev)** - Source code and issues
- **[omni-dev-commit-check Action](https://github.com/action-works/omni-dev-commit-check)** - GitHub Action for CI commit validation
- **[Crates.io Page](https://crates.io/crates/omni-dev)** - Package information
- **[Rust API Docs](https://docs.rs/omni-dev)** - Generated API documentation
- **[GitHub Discussions](https://github.com/rust-works/omni-dev/discussions)** - Community support
- **[Anthropic Console](https://console.anthropic.com/)** - Get your Claude API key

## 🤝 Community

- **Questions**: Use [GitHub Discussions](https://github.com/rust-works/omni-dev/discussions)
- **Bug Reports**: Open an [Issue](https://github.com/rust-works/omni-dev/issues)  
- **Feature Requests**: Start a [Discussion](https://github.com/rust-works/omni-dev/discussions) first
- **Contributions**: See [Contributing Guidelines](../CONTRIBUTING.md)

## 📅 Documentation Maintenance

This documentation is maintained alongside the codebase and updated with each release. If you find any issues or have suggestions for improvement:

1. **Minor fixes**: Submit a pull request directly
2. **Major changes**: Open an issue for discussion first
3. **New examples**: Contributions welcome via pull request

---

**Need help choosing where to start?**

- **New to omni-dev**: [README](../README.md) → [User Guide](user-guide.md)
- **Setting up a project**: [Configuration Guide](configuration.md)
- **Having issues**: [Troubleshooting](troubleshooting.md)
- **Want examples**: [Examples](examples.md)
- **Contributing**: [Contributing Guidelines](../CONTRIBUTING.md)
