Commit aca067f
committed
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
File tree
- docs
- guides
- modules
- src
- __tests__/fixtures
- batch
- base
- target
- lib
- classifiers
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
313 | 313 | | |
314 | 314 | | |
315 | 315 | | |
| 316 | + | |
| 317 | + | |
| 318 | + | |
| 319 | + | |
| 320 | + | |
| 321 | + | |
| 322 | + | |
| 323 | + | |
| 324 | + | |
| 325 | + | |
| 326 | + | |
| 327 | + | |
| 328 | + | |
| 329 | + | |
| 330 | + | |
| 331 | + | |
| 332 | + | |
| 333 | + | |
| 334 | + | |
| 335 | + | |
| 336 | + | |
| 337 | + | |
| 338 | + | |
| 339 | + | |
| 340 | + | |
316 | 341 | | |
317 | 342 | | |
318 | 343 | | |
| |||
0 commit comments