docs: add missing docs to mkdocs nav and README index
- 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>
This commit is contained in:
@@ -7,6 +7,7 @@ Welcome to the DocuElevate documentation. This directory contains comprehensive
|
|||||||
### Getting Started
|
### Getting Started
|
||||||
- [Setup Wizard Guide](SetupWizard.md) - First-run wizard walkthrough and initial configuration
|
- [Setup Wizard Guide](SetupWizard.md) - First-run wizard walkthrough and initial configuration
|
||||||
- [User Guide](UserGuide.md) - How to use DocuElevate's features and interface
|
- [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
|
||||||
- [Deployment Guide](DeploymentGuide.md) - Docker Compose and Kubernetes/Helm deployment
|
- [Deployment Guide](DeploymentGuide.md) - Docker Compose and Kubernetes/Helm deployment
|
||||||
@@ -16,6 +17,7 @@ Welcome to the DocuElevate documentation. This directory contains comprehensive
|
|||||||
### Configuration
|
### Configuration
|
||||||
- [Configuration Overview](ConfigurationMaster.md) - Overview of configuration options, including:
|
- [Configuration Overview](ConfigurationMaster.md) - Overview of configuration options, including:
|
||||||
- [Configuration Guide](ConfigurationGuide.md) - Complete list of all available configuration parameters
|
- [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
|
- [Database Configuration](DatabaseConfiguration.md) - SQLite, PostgreSQL, migrations, and optimization
|
||||||
- [Google Drive Setup](GoogleDriveSetup.md) - How to set up Google Drive integration
|
- [Google Drive Setup](GoogleDriveSetup.md) - How to set up Google Drive integration
|
||||||
- [Dropbox Setup](DropboxSetup.md) - How to set up Dropbox integration
|
- [Dropbox Setup](DropboxSetup.md) - How to set up Dropbox integration
|
||||||
@@ -24,6 +26,9 @@ Welcome to the DocuElevate documentation. This directory contains comprehensive
|
|||||||
- [Authentication Setup](AuthenticationSetup.md) - How to set up user authentication
|
- [Authentication Setup](AuthenticationSetup.md) - How to set up user authentication
|
||||||
- [Notifications Setup](NotificationsSetup.md) - How to set up system notifications
|
- [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
|
### Reference
|
||||||
- [API Documentation](API.md) - Complete API reference for developers
|
- [API Documentation](API.md) - Complete API reference for developers
|
||||||
- [Configuration Troubleshooting](ConfigurationTroubleshooting.md) - Solutions to common configuration issues
|
- [Configuration Troubleshooting](ConfigurationTroubleshooting.md) - Solutions to common configuration issues
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ nav:
|
|||||||
- Getting Started:
|
- Getting Started:
|
||||||
- Setup Wizard: SetupWizard
|
- Setup Wizard: SetupWizard
|
||||||
- User Guide: UserGuide
|
- User Guide: UserGuide
|
||||||
|
- Browser Extension: BrowserExtension
|
||||||
- API: API
|
- API: API
|
||||||
- Deployment:
|
- Deployment:
|
||||||
- Overview: DeploymentGuide
|
- Overview: DeploymentGuide
|
||||||
@@ -24,6 +25,7 @@ nav:
|
|||||||
- Configuration:
|
- Configuration:
|
||||||
- Overview: ConfigurationMaster
|
- Overview: ConfigurationMaster
|
||||||
- Configuration Guide: ConfigurationGuide
|
- Configuration Guide: ConfigurationGuide
|
||||||
|
- Settings Management: SettingsManagement
|
||||||
- Database: DatabaseConfiguration
|
- Database: DatabaseConfiguration
|
||||||
- Dropbox: DropboxSetup
|
- Dropbox: DropboxSetup
|
||||||
- Google Drive: GoogleDriveSetup
|
- Google Drive: GoogleDriveSetup
|
||||||
@@ -31,6 +33,8 @@ nav:
|
|||||||
- Amazon S3: AmazonS3Setup
|
- Amazon S3: AmazonS3Setup
|
||||||
- Authentication: AuthenticationSetup
|
- Authentication: AuthenticationSetup
|
||||||
- Notifications: NotificationsSetup
|
- Notifications: NotificationsSetup
|
||||||
|
- Security:
|
||||||
|
- Credential Rotation: CredentialRotationGuide
|
||||||
- Troubleshooting:
|
- Troubleshooting:
|
||||||
- General: Troubleshooting
|
- General: Troubleshooting
|
||||||
- Configuration: ConfigurationTroubleshooting
|
- Configuration: ConfigurationTroubleshooting
|
||||||
|
|||||||
Reference in New Issue
Block a user