Welcome to the XL documentation. This index helps you find what you need quickly.
| I want to... | Go to |
|---|---|
| Get started in 5 minutes | QUICK-START.md |
| See code examples | reference/examples.md |
| Use the CLI tool | reference/cli.md |
| Contribute code | CONTRIBUTING.md |
| Check current status | STATUS.md |
- GitHub Issues - Issues and discussions
- plan/roadmap.md - Release roadmap
- QUICK-START.md - Installation, first spreadsheet, reading files
- FAQ-AND-GLOSSARY.md - Common questions and terminology
- reference/examples.md - End-to-end code examples
- reference/performance-guide.md - In-memory vs streaming, optimization
- reference/migration-from-poi.md - Coming from Apache POI
- reference/cli.md - Command reference, examples, LLM integration
- CONTRIBUTING.md - Code quality, pre-commit hooks
- reference/testing-guide.md - MUnit, ScalaCheck, property tests
- reference/implementation-scaffolds.md - Code templates
- design/architecture.md - Module dependencies, I/O flow
- design/domain-model.md - Core types (Cell, Sheet, Workbook)
- design/purity-charter.md - Pure FP principles
- design/decisions.md - Architectural decision records (ADRs)
- design/io-modes.md - In-memory vs streaming comparison
- reference/performance-guide.md - Mode selection, benchmarks
- design/io-modes.md - Streaming architecture
- reference/ooxml-research.md - Excel file format details
- STATUS.md - Current capabilities, test coverage
- LIMITATIONS.md - Known limitations, workarounds
- RELEASING.md - Maven Central publishing process
- ../CHANGELOG.md - Version history