copilot-swe-agent[bot]
46b2f17acc
- Add MkDocs Material docs build stage to Dockerfile and Dockerfile.local - Mount pre-built docs as static files at /help/ in FastAPI (app/main.py) - Add app/views/help.py with /help → /help/ permanent redirect route - Register help router in app/views/__init__.py - Add Help nav link to base.html (public + app nav, desktop + mobile) - Create how-to guides: HP printer, ScanSnap, watched folder, email ingestion, mobile scanning - Update mkdocs.yml with How-To Guides section and Material theme palette - Add optional docs service (squidfunk/mkdocs-material) to docker-compose.yaml with docs profile - Add mkdocs-material to requirements-dev.txt - Add /docs_build to .gitignore - Add tests for help view (8 tests, 100% coverage on help.py) Co-authored-by: christianlouis <361235+christianlouis@users.noreply.github.com>
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 - First-run wizard walkthrough and initial configuration
- User Guide - How to use DocuElevate's features and interface
- Browser Extension - Send files and clip web pages directly from your browser
Deployment
- Deployment Guide - Docker Compose and Kubernetes/Helm deployment
- Kubernetes Deployment Guide - Detailed Kubernetes/Helm reference
- Production Readiness Guide - Checklist to go from "it works" to production-hardened
Configuration
- Configuration Overview - Overview of configuration options, including:
- Configuration Guide - Complete list of all available configuration parameters
- Settings Management - Web-based settings UI and API reference
- Database Configuration - SQLite, PostgreSQL, migrations, and optimization
- Google Drive Setup - How to set up Google Drive integration
- Dropbox Setup - How to set up Dropbox integration
- OneDrive Setup - How to set up Microsoft OneDrive/Graph integration
- Amazon S3 Setup - How to set up Amazon S3 integration
- Authentication Setup - How to set up user authentication
- Notifications Setup - How to set up system notifications
Security
- Credential Rotation Guide - Procedures for rotating API keys, passwords, and OAuth tokens
Reference
- API Documentation - Complete API reference for developers
- Configuration Troubleshooting - Solutions to common configuration issues
- Troubleshooting - General troubleshooting and solutions to common issues
- Licensing & Compliance - License information and third-party dependency compliance
Additional Resources
- Contributing Guide - How to contribute to DocuElevate development
- License Information - Apache License 2.0 details
Support
If you need additional assistance beyond what's covered in these guides:
- Check the GitHub repository for updates and issues
- Contact the developer through the information provided on the About page
Screenshots
DocuElevate's upload interface
Document management interface
System management interface
DocuElevate processing workflow