Add comprehensive architecture documentation with UML diagrams
This commit is contained in:
@@ -303,6 +303,18 @@ Error converting JSON to markdown: Expecting property name enclosed in double qu
|
||||
- Supported file formats: PDF, JPG, JPEG, PNG, WEBP, GIF
|
||||
- Rate limits may apply depending on your Mistral AI account tier
|
||||
|
||||
## Architecture Documentation
|
||||
|
||||
For a comprehensive overview of the Mistral OCR architecture, including UML diagrams, sequence diagrams, and other visual representations, please refer to the [ARCHITECTURE.md](ARCHITECTURE.md) document. This documentation provides detailed insights into:
|
||||
|
||||
- Class structure and relationships
|
||||
- Component architecture
|
||||
- Process workflows
|
||||
- Data flow through the system
|
||||
- User interaction patterns
|
||||
|
||||
These diagrams are useful for understanding the system design, onboarding new contributors, and planning future enhancements.
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions to Mistral OCR CLI are welcome! Here's how you can contribute:
|
||||
@@ -319,7 +331,7 @@ Contributions to Mistral OCR CLI are welcome! Here's how you can contribute:
|
||||
```
|
||||
5. **Submit a pull request**
|
||||
|
||||
Please ensure your code follows the project's coding standards and includes appropriate tests and documentation.
|
||||
Please ensure your code follows the project's coding standards and includes appropriate tests and documentation. For understanding the codebase structure, refer to the [ARCHITECTURE.md](ARCHITECTURE.md) document.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user