Skip to content

Commit aca067f

Browse files
docs: add comprehensive documentation structure and enhance JSDoc
- Create complete documentation hierarchy in docs/ directory - Add architecture overview documenting system design and components - Add comprehensive API reference with examples and best practices - Create getting started guide with installation and usage instructions - Add testing guide covering test structure and writing tests - Create troubleshooting guide for common issues and solutions - Add classification system documentation explaining difference types - Create documentation index for easy navigation - Enhance JSDoc comments in ImageProcessor with detailed examples - Enhance JSDoc comments in BatchProcessor for batch operations - Enhance JSDoc comments in DifferenceClassifier base class - Update README with documentation section linking to all guides - Remove obsolete type-fixing-log.md Documentation now covers: - Getting started and installation - Complete API reference - Architecture and design decisions - Testing strategies - Troubleshooting common issues - Module-specific guides 🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 28bc771 commit aca067f

20 files changed

Lines changed: 2795 additions & 84 deletions

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,31 @@ if (!result.isEqual) {
313313
}
314314
```
315315

316+
## 📚 Documentation
317+
318+
Comprehensive documentation is available in the [docs](./docs) directory:
319+
320+
### Getting Started
321+
- [Getting Started Guide](./docs/guides/GETTING_STARTED.md) - Installation and first steps
322+
- [Examples](./examples/README.md) - Code examples for common use cases
323+
- [API Reference](./docs/API-REFERENCE.md) - Complete API documentation
324+
325+
### Guides
326+
- [CLI Usage](./docs/guides/CLI_USAGE.md) - Command-line interface guide
327+
- [Batch Processing](./docs/guides/BATCH_PROCESSING.md) - Processing multiple images
328+
- [Classification System](./docs/modules/classifiers.md) - Understanding change types
329+
- [Troubleshooting](./docs/TROUBLESHOOTING.md) - Common issues and solutions
330+
331+
### Advanced Topics
332+
- [Architecture Overview](./docs/ARCHITECTURE.md) - System design and internals
333+
- [Testing Guide](./docs/guides/TESTING.md) - Running and writing tests
334+
- [OpenCV Setup](./docs/OPENCV_SETUP.md) - Advanced alignment features
335+
336+
### Quick Links
337+
- [Documentation Index](./docs/INDEX.md) - Complete documentation map
338+
- [FAQ](./docs/guides/FAQ.md) - Frequently asked questions
339+
- [Contributing](./CONTRIBUTING.md) - How to contribute
340+
316341
### CI/CD Integration
317342

318343
#### GitHub Actions

0 commit comments

Comments
 (0)