copilot-swe-agent[bot]
6e78e9e7cf
- Add BrowserExtension to Getting Started section in mkdocs.yml nav - Add SettingsManagement to Configuration section in mkdocs.yml nav - Add new Security section with CredentialRotationGuide in mkdocs.yml nav - Mirror all nav additions in docs/README.md index Closes the documentation gaps identified in the health check audit: all user-relevant guides (browser extension, settings management, credential rotation) are now discoverable via ReadTheDocs/mkdocs. Co-authored-by: christianlouis <361235+christianlouis@users.noreply.github.com>
63 lines
3.0 KiB
Markdown
63 lines
3.0 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
|
|
- [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
|
|
|
|
|
|
*DocuElevate's upload interface*
|
|
|
|
|
|
*Document management interface*
|
|
|
|
|
|
*System management interface*
|
|
|
|
|
|
*DocuElevate processing workflow*
|