feat: add comprehensive documentation including user guide, API reference, and deployment instructions

This commit is contained in:
Christian Krakau-Louis
2025-03-31 10:58:01 +02:00
parent 92a387a759
commit 5aff586fb0
7 changed files with 635 additions and 11 deletions
+34
View File
@@ -0,0 +1,34 @@
# DocuNova Documentation
Welcome to the DocuNova documentation. This directory contains comprehensive guides to help you install, configure, and use DocuNova effectively.
## Available Documentation
- [User Guide](UserGuide.md) - How to use DocuNova's features and interface
- [API Documentation](API.md) - Complete API reference for developers
- [Deployment Guide](DeploymentGuide.md) - How to deploy DocuNova in various environments
- [Configuration Guide](ConfigurationGuide.md) - All available configuration options
- [Troubleshooting](Troubleshooting.md) - Solutions to common issues
## Additional Resources
- [Contributing Guide](../CONTRIBUTING.md) - How to contribute to DocuNova development
- [License Information](../LICENSE) - Apache License 2.0 details
## Support
If you need additional assistance beyond what's covered in these guides:
1. Check the [GitHub repository](https://github.com/christianlouis/document-processor) for updates and issues
2. Contact the developer through the information provided on the About page
## Screenshots
![Upload Interface](upload-view.png)
*DocuNova's upload interface*
![Files View](files-view.png)
*Document management interface*
![Workflow Diagram](workflow-diagram.png)
*DocuNova processing workflow*