Files
gh-christianlouis-docuelevate/docs/README.md
copilot-swe-agent[bot] e518bce922 fix: merge main branch and renumber migration 037→040
Resolve all merge conflicts between our automation feature branch and
current main (v0.163.0, 920 commits ahead).

Conflicts resolved:
- app/api/__init__.py: add automation_router alongside main's new routers
  (classification_rules, qr_auth, sessions, system_reset)
- app/config.py: add main's new settings (dropbox_use_global_credentials,
  factory_reset_on_startup, enable_factory_reset)
- app/models.py: add main's new models (ClassificationRuleModel, UserSession,
  QRLoginChallenge, SharePoint integration type)
- app/utils/settings_service.py: merge automation_hooks_enabled with main's
  new metadata entries
- docs/API.md: merge automation API docs with main's classification rules docs
- docs/ConfigurationGuide.md: add factory reset settings
- tests/conftest.py: import both AutomationHook and new main models

Migration renumbered:
- 037_add_automation_hooks → 040_add_automation_hooks
- down_revision: 039_add_classification_rules (was 036_add_document_translation_fields)
- Chain: 036 → 037 → 038 → 039 → 040 (automation hooks)

For all non-automation files with conflicts, main's version was taken since
our branch did not modify those files (conflicts were from a stale prior merge).

Co-authored-by: christianlouis <361235+christianlouis@users.noreply.github.com>
Agent-Logs-Url: https://github.com/christianlouis/DocuElevate/sessions/cb62f012-3b69-4415-835e-3857ce3e9f45
2026-03-20 23:54:04 +00:00

64 lines
3.1 KiB
Markdown

# DocuElevate Documentation
Welcome to the DocuElevate documentation. This directory contains comprehensive guides to help you install, configure, and use DocuElevate effectively.
## Available Documentation
### Getting Started
- [Setup Wizard Guide](SetupWizard.md) - First-run wizard walkthrough and initial configuration
- [User Guide](UserGuide.md) - How to use DocuElevate's features and interface
- [Browser Extension](BrowserExtension.md) - Send files and clip web pages directly from your browser
### Deployment
- [Deployment Guide](DeploymentGuide.md) - Docker Compose and Kubernetes/Helm deployment
- [Kubernetes Deployment Guide](KubernetesDeployment.md) - Detailed Kubernetes/Helm reference
- [Production Readiness Guide](ProductionReadiness.md) - Checklist to go from "it works" to production-hardened
### Configuration
- [Configuration Overview](ConfigurationMaster.md) - Overview of configuration options, including:
- [Configuration Guide](ConfigurationGuide.md) - Complete list of all available configuration parameters
- [Settings Management](SettingsManagement.md) - Web-based settings UI and API reference
- [Database Configuration](DatabaseConfiguration.md) - SQLite, PostgreSQL, migrations, and optimization
- [Google Drive Setup](GoogleDriveSetup.md) - How to set up Google Drive integration
- [Dropbox Setup](DropboxSetup.md) - How to set up Dropbox integration
- [OneDrive Setup](OneDriveSetup.md) - How to set up Microsoft OneDrive/Graph integration
- [SharePoint Setup](SharePointSetup.md) - How to set up Microsoft SharePoint Online integration
- [Amazon S3 Setup](AmazonS3Setup.md) - How to set up Amazon S3 integration
- [Authentication Setup](AuthenticationSetup.md) - How to set up user authentication
- [Notifications Setup](NotificationsSetup.md) - How to set up system notifications
### Security
- [Credential Rotation Guide](CredentialRotationGuide.md) - Procedures for rotating API keys, passwords, and OAuth tokens
### Reference
- [API Documentation](API.md) - Complete API reference for developers
- [Configuration Troubleshooting](ConfigurationTroubleshooting.md) - Solutions to common configuration issues
- [Troubleshooting](Troubleshooting.md) - General troubleshooting and solutions to common issues
- [Licensing & Compliance](LicensingCompliance.md) - License information and third-party dependency compliance
## Additional Resources
- [Contributing Guide](../CONTRIBUTING.md) - How to contribute to DocuElevate 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)
*DocuElevate's upload interface*
![Files View](files-view.png)
*Document management interface*
![Status View](status-view.png)
*System management interface*
![Workflow Diagram](workflow-diagram.png)
*DocuElevate processing workflow*