sonarqube-issues-exporter/docs/README.md

Enterprise-level SonarQube issues exporter with TypeScript support for generating comprehensive HTML reports with dark theme

# 📚 Documentation

Welcome to the SonarQube Issues Exporter documentation! This directory contains comprehensive guides and references organized by audience and purpose.

## 📖 Quick Navigation

### 🎯 For Users

- **[NPM Guide](./user-guide/npm-guide.md)** - Complete installation and usage guide
- **[Migration Guide](./user-guide/migration.md)** - Upgrading from previous versions
- **[Security Guide](./user-guide/security.md)** - Security best practices and considerations

### 👨‍💻 For Developers & Contributors

- **[Contributing Guide](./development/contributing.md)** - How to contribute to the project
- **[Commit Guidelines](./development/commit-guidelines.md)** - Conventional commit standards
- **[Publishing Guide](./development/publishing.md)** - Release and publishing process
- **[Versioning Guide](./development/versioning.md)** - Semantic versioning strategy

### 📋 Project Information

- **[Enhancement Plan](./project/enhancement-plan.md)** - Current development roadmap and phases
- **[Documentation Updates](./project/documentation-updates.md)** - Recent documentation changes

## 🚀 Getting Started

### New Users

1. Start with the **[NPM Guide](./user-guide/npm-guide.md)** for installation and basic usage
2. Check the **[Security Guide](./user-guide/security.md)** for best practices
3. Visit the main **[README](../README.md)** for feature overview and examples

### Contributors

1. Read the **[Contributing Guide](./development/contributing.md)** for development setup
2. Follow **[Commit Guidelines](./development/commit-guidelines.md)** for your contributions
3. Check the **[Enhancement Plan](./project/enhancement-plan.md)** for current development priorities

### Maintainers

1. Review **[Publishing Guide](./development/publishing.md)** for release process
2. Understand **[Versioning Guide](./development/versioning.md)** for version management
3. Monitor **[Documentation Updates](./project/documentation-updates.md)** for recent changes

## 📁 Directory Structure

```
docs/
├── README.md                           # This file - documentation overview
├── user-guide/                        # End-user documentation
│   ├── npm-guide.md                   # Installation & usage
│   ├── migration.md                   # Version migration
│   └── security.md                    # Security considerations
├── development/                       # Developer documentation
│   ├── contributing.md                # Contribution guidelines
│   ├── commit-guidelines.md           # Commit conventions
│   ├── publishing.md                  # Release process
│   └── versioning.md                  # Version management
└── project/                          # Project management docs
    ├── enhancement-plan.md            # Development roadmap
    └── documentation-updates.md       # Doc change history
```

## 🔄 Root Level Files

Some documentation remains at the project root for immediate visibility:

- **[README.md](../README.md)** - Main project overview and quick start
- **[CHANGELOG.md](../CHANGELOG.md)** - Auto-generated release history
- **[LICENSE](../LICENSE)** - MIT license information

## 🤝 Contributing to Documentation

Found an issue or want to improve the documentation?

1. **Quick fixes**: Edit the relevant file and submit a pull request
2. **Major changes**: Open an issue first to discuss the changes
3. **New sections**: Follow the existing structure and update this README

### Documentation Standards

- Use clear, concise language
- Include code examples where helpful
- Keep navigation links updated
- Follow the established directory structure
- Test all links and examples before submitting

## 📞 Support

- **Issues**: [GitHub Issues](https://github.com/The-Lone-Druid/sonarqube-issues-exporter/issues)
- **Discussions**: [GitHub Discussions](https://github.com/The-Lone-Druid/sonarqube-issues-exporter/discussions)
- **Security**: See [Security Guide](./user-guide/security.md)

---

**Happy coding!** 🎉