# ๐Ÿ“š ZPL2PDF - Documentation Index Welcome to the ZPL2PDF documentation! This index helps you find the right documentation for your needs. --- ## ๐ŸŒ **Documentation by Language** ### Translated READMEs - ๐Ÿ‡บ๐Ÿ‡ธ [English](../README.md) - Main README (root folder) - ๐Ÿ‡ง๐Ÿ‡ท [Portuguรชs (Brasil)](i18n/README.pt-BR.md) - ๐Ÿ‡ช๐Ÿ‡ธ [Espaรฑol](i18n/README.es-ES.md) - ๐Ÿ‡ซ๐Ÿ‡ท [Franรงais](i18n/README.fr-FR.md) - ๐Ÿ‡ฉ๐Ÿ‡ช [Deutsch](i18n/README.de-DE.md) - ๐Ÿ‡ฎ๐Ÿ‡น [Italiano](i18n/README.it-IT.md) - ๐Ÿ‡ฏ๐Ÿ‡ต [ๆ—ฅๆœฌ่ชž](i18n/README.ja-JP.md) - ๐Ÿ‡จ๐Ÿ‡ณ [ไธญๆ–‡ (็ฎ€ไฝ“)](i18n/README.zh-CN.md) **Want to contribute improvements?** See [CONTRIBUTING.md](../CONTRIBUTING.md) --- ## ๐Ÿ“– **User Guides** Documentation for end-users: ### Getting Started - ๐Ÿš€ [Quick Start Guide](../README.md#quick-start) - Get up and running in 5 minutes - ๐Ÿ“ฆ [Installation Guide](../README.md#installation) - All installation methods ### Usage Guides - ๐Ÿณ [Docker Guide](guides/DOCKER_GUIDE.md) - Complete Docker usage with examples - ๐ŸŒ [Multi-Language Configuration](guides/LANGUAGE_CONFIGURATION.md) - Set up your preferred language - ๐Ÿงช [Docker Testing Guide](guides/DOCKER_TESTING.md) - Test ZPL2PDF on all platforms - ๐Ÿ“ฆ [Windows Installer Guide](guides/INNO_SETUP_GUIDE.md) - Professional Windows installation ### Advanced Topics - โš™๏ธ [Configuration Reference](../zpl2pdf.json.example) - All configuration options - ๐Ÿ”ง [Troubleshooting](../README.md#troubleshooting) - Common issues and solutions - ๐Ÿ“Š [Performance Optimization](../README.md#performance) - Benchmarks and tips --- ## ๐Ÿ› ๏ธ **Developer Documentation** Documentation for contributors and developers: ### Development Workflow - ๐Ÿค [Contributing Guide](../CONTRIBUTING.md) - How to contribute - ๐Ÿ“‹ [Changelog](../CHANGELOG.md) - Version history - ๐Ÿ”„ [CI/CD Workflow](development/CI_CD_WORKFLOW.md) - Automated build and deployment ### Build & Deployment - ๐Ÿ”จ [Build Scripts Documentation](../scripts/README.md) - Build for all platforms - ๐Ÿณ [Docker Publishing Guide](development/DOCKER_PUBLISH_GUIDE.md) - Publish Docker images - ๐Ÿ“ [Build Validation](development/BUILD_SCRIPTS_VALIDATION.md) - Validate builds - ๐Ÿ“ฆ [Installer Documentation](../installer/README.md) - Windows installer creation ### Internal Documentation - ๐Ÿ—๏ธ [Architecture Overview](development/ARCHITECTURE.md) *(Coming soon)* - ๐Ÿงช [Testing Strategy](../tests/ZPL2PDF.Unit/PLANO_TESTES.md) - ๐Ÿ“š [API Documentation](development/API.md) *(Coming soon)* --- ## ๐ŸŽฏ **Quick Links by Task** ### "I want to..." | Task | Documentation | |------|--------------| | **Install ZPL2PDF** | [Installation Guide](../README.md#installation) | | **Convert a ZPL file** | [Quick Start](../README.md#quick-start) | | **Set up auto-conversion** | [Daemon Mode Guide](../README.md#daemon-mode) | | **Use Docker** | [Docker Guide](guides/DOCKER_GUIDE.md) | | **Change language** | [Language Configuration](guides/LANGUAGE_CONFIGURATION.md) | | **Build from source** | [Development Setup](../CONTRIBUTING.md#development-setup) | | **Contribute code** | [Contributing Guide](../CONTRIBUTING.md) | | **Report a bug** | [Bug Reports](../CONTRIBUTING.md#bug-reports) | | **Request a feature** | [Feature Requests](../CONTRIBUTING.md#feature-requests) | | **Publish a release** | [CI/CD Workflow](development/CI_CD_WORKFLOW.md) | | **Test on Linux** | [Docker Testing](guides/DOCKER_TESTING.md) | --- ## ๐Ÿ“ **Documentation Structure** ``` docs/ โ”œโ”€โ”€ README.md (This file - Documentation index) โ”œโ”€โ”€ i18n/ (Internationalization) โ”‚ โ”œโ”€โ”€ README.pt-BR.md (Portuguese) โ”‚ โ”œโ”€โ”€ README.es-ES.md (Spanish) โ”‚ โ””โ”€โ”€ README.fr-FR.md (French) โ”œโ”€โ”€ guides/ (User guides) โ”‚ โ”œโ”€โ”€ DOCKER_GUIDE.md (Docker usage) โ”‚ โ”œโ”€โ”€ DOCKER_TESTING.md (Cross-platform testing) โ”‚ โ”œโ”€โ”€ INNO_SETUP_GUIDE.md (Windows installer) โ”‚ โ””โ”€โ”€ LANGUAGE_CONFIGURATION.md (Multi-language setup) โ”œโ”€โ”€ development/ (Developer docs) โ”‚ โ”œโ”€โ”€ CI_CD_WORKFLOW.md (Automation workflow) โ”‚ โ”œโ”€โ”€ BUILD_SCRIPTS_VALIDATION.md (Build validation) โ”‚ โ”œโ”€โ”€ DOCKER_PUBLISH_GUIDE.md (Docker publishing) โ”‚ โ”œโ”€โ”€ DOCKER_RESUMO_PUBLICACAO.md (Publishing summary PT) โ”‚ โ””โ”€โ”€ DOCKER_SUMMARY.md (Docker summary) โ”œโ”€โ”€ Image/ (Screenshots & icons) โ”‚ โ”œโ”€โ”€ ZPL2PDF.ico โ”‚ โ”œโ”€โ”€ ZPL2PDF.png โ”‚ โ””โ”€โ”€ example_*.png โ””โ”€โ”€ Sample/ (Sample ZPL files) โ”œโ”€โ”€ example.txt โ”œโ”€โ”€ test-*.txt โ””โ”€โ”€ *.prn ``` --- ## ๐Ÿ” **Search Documentation** Can't find what you're looking for? Try: 1. **Search the Wiki**: [GitHub Wiki](https://github.com/brunoleocam/ZPL2PDF/wiki) 2. **Browse Issues**: [GitHub Issues](https://github.com/brunoleocam/ZPL2PDF/issues) 3. **Ask in Discussions**: [GitHub Discussions](https://github.com/brunoleocam/ZPL2PDF/discussions) --- ## ๐Ÿ†• **Recently Updated** - ๐Ÿ“… **2025-01-07**: Docker Publishing Guide - ๐Ÿ“… **2025-01-07**: Multi-language Configuration Guide - ๐Ÿ“… **2025-01-07**: CI/CD Workflow Documentation - ๐Ÿ“… **2025-01-07**: Inno Setup Guide --- ## ๐Ÿค **Contributing to Documentation** Found a typo or want to improve the docs? 1. Fork the repository 2. Edit the documentation 3. Submit a Pull Request See [Contributing Guide](../CONTRIBUTING.md#documentation) for details. --- **Need help?** Open an [Issue](https://github.com/brunoleocam/ZPL2PDF/issues) or start a [Discussion](https://github.com/brunoleocam/ZPL2PDF/discussions)!