documentation fixes

Murtaza Nsair · Murtaza Nsair · commit de7dc194899a · 2025-09-02T03:24:29.000-05:00
diff --git a/README.md b/README.md
diff --git a/docs/getting-started/configuration/ai-providers.md b/docs/getting-started/configuration/ai-providers.md
@@ -2,7 +2,7 @@
 
 Configure language model providers to power MAESTRO's research and writing capabilities.
 
-![AI Configuration Interface](../../assets/images/settings/ai-config.png)
+![AI Configuration Interface](//assets/images/settings/ai-config.png)
 
 ## Overview
 
diff --git a/docs/getting-started/configuration/environment-variables.md b/docs/getting-started/configuration/environment-variables.md
@@ -317,4 +317,23 @@ ALLOW_CORS_WILDCARD=false
 - [AI Provider Configuration](ai-providers.md) - Configure LLMs
 - [Search Provider Configuration](search-providers.md) - Set up web search
 - [First Login](../first-login.md) - Initial setup guide
-- [Configuration Overview](overview.md) - General configuration guide
+- [Configuration Overview](overview.md) - General configuration guide
+
+## Backup
+
+To backup your MAESTRO installation:
+
+1. **Database Backup**:
+   ```bash
+   docker exec maestro-postgres pg_dump -U maestro_user maestro_db > backup.sql
+   ```
+
+2. **Document Files Backup**:
+   ```bash
+   tar -czf documents.tar.gz ./data/raw_files ./data/markdown_files
+   ```
+
+3. **Vector Store Backup**:
+   ```bash
+   tar -czf vector_store.tar.gz ./data/vector_store
+   ```
diff --git a/docs/getting-started/configuration/search-providers.md b/docs/getting-started/configuration/search-providers.md
@@ -2,7 +2,7 @@
 
 Enable web search capabilities for MAESTRO's research agents to access current information from the internet.
 
-![Search Configuration Interface](../../assets/images/settings/search.png)
+![Search Configuration Interface](//assets/images/settings/search.png)
 
 ## Overview
 
diff --git a/docs/getting-started/configuration/web-fetch.md b/docs/getting-started/configuration/web-fetch.md
@@ -2,7 +2,7 @@
 
 Configure how MAESTRO fetches and processes full content from web pages discovered during research.
 
-![Web Fetch Configuration Interface](../../assets/images/settings/web-fetch.png)
+![Web Fetch Configuration Interface](//assets/images/settings/web-fetch.png)
 
 ## Overview
 
diff --git a/docs/getting-started/first-login.md b/docs/getting-started/first-login.md
@@ -47,7 +47,7 @@ grep ADMIN_PASSWORD .env
 
 ### Step 2: Configure AI Provider
 
-![AI Configuration](../assets/images/settings/ai-config.png)
+![AI Configuration](/assets/images/settings/ai-config.png)
 
 1. Stay in Settings, click **AI Config** tab
 2. Select your AI Provider:
@@ -65,7 +65,7 @@ grep ADMIN_PASSWORD .env
 
 ### Step 3: Configure Search Provider (Optional)
 
-![Search Configuration](../assets/images/settings/search.png)
+![Search Configuration](/assets/images/settings/search.png)
 
 1. Click **Search** tab in Settings
 2. Select a search provider:
@@ -79,7 +79,7 @@ grep ADMIN_PASSWORD .env
 
 ### Step 4: Upload Your First Documents
 
-![Document Library](../../images/01-document-library.png)
+<!-- Image not available: Document Library (01-document-library.png) -->
 
 1. Navigate to **Documents** tab
 2. Create a Document Group and Select it from the sidebar
@@ -191,9 +191,9 @@ grep ADMIN_PASSWORD .env
 
 ### Documentation
 
-- [User Guide](../../user-guide/index.md) - Complete feature guide
-- [Troubleshooting](../../troubleshooting/index.md) - Problem solving
-- [FAQ](../../troubleshooting/faq.md) - Common questions
+- [User Guide](../user-guide/index.md) - Complete feature guide
+- [Troubleshooting](../troubleshooting/index.md) - Problem solving
+- [FAQ](../troubleshooting/faq.md) - Common questions
 
 ### Community Support
 
diff --git a/docs/getting-started/installation/cli-commands.md b/docs/getting-started/installation/cli-commands.md
@@ -370,4 +370,4 @@ docker compose logs maestro-backend --tail=100
 - [Database Management](database-reset.md) - Database operations
 - [User Guide](../../user-guide/index.md) - Using the web interface
 - [Troubleshooting](../../troubleshooting/index.md) - Common issues
-- [API Reference](../../api/index.md) - REST API documentation
+- [API Reference](#) - REST API documentation
diff --git a/docs/getting-started/installation/database-reset.md b/docs/getting-started/installation/database-reset.md
@@ -260,4 +260,4 @@ docker system prune -a --volumes
 
 - [CLI Usage Guide](cli-commands.md)
 - [Document Processing](../../user-guide/documents/overview.md)
-- [Backup Automation](../configuration/backup.md)
+- [Backup Automation](../configuration/environment-variables.md#backup)
diff --git a/docs/getting-started/installation/docker.md b/docs/getting-started/installation/docker.md
@@ -319,7 +319,7 @@ docker stack deploy -c docker-compose.yml maestro
 
 ### Kubernetes
 
-See [Kubernetes Deployment](../../deployment/kubernetes/helm-chart.md) for Helm chart installation.
+See [Kubernetes Deployment](../../deployment/local-llms.md) for Helm chart installation.
 
 ## Troubleshooting
 
@@ -416,4 +416,4 @@ After successful installation:
 3. **[Upload Documents](../../user-guide/documents/uploading.md)** - Build your library
 4. **[Quick Start Guide](../quickstart.md)** - Start using MAESTRO
 
-For additional help, see our [Troubleshooting Guide](../../troubleshooting/index.md) or visit the [Community Forum](../../community/discussions.md).
+For additional help, see our [Troubleshooting Guide](../../troubleshooting/index.md) or visit the [Community Forum](https://github.com/murtaza-nasir/maestro/discussions).
diff --git a/docs/troubleshooting/common-issues/ai-models.md b/docs/troubleshooting/common-issues/ai-models.md
@@ -14,7 +14,7 @@ Quick fixes for AI model configuration and API issues.
 4. Click "Test" button
 5. Models should populate automatically
 
-![AI Config Model Selection](../../assets/images/troubleshooting/ai-config-model-selection.png)
+<!-- Image not available: AI Config Model Selection (ai-config-model-selection.png) -->
 
 **If still empty:**
 ```bash
diff --git a/docs/troubleshooting/index.md b/docs/troubleshooting/index.md
@@ -226,7 +226,7 @@ docker compose restart maestro-backend
 ### Check Documentation
 
 - [Installation Guide](../getting-started/installation/index.md)
-- [Common Issues](common-issues/index.md)
+- [Common Issues](common-issues/installation.md)
 - [Logs Guide](logs.md)
 - [Database Reset](database-reset.md)
 
diff --git a/docs/troubleshooting/logs.md b/docs/troubleshooting/logs.md
@@ -168,6 +168,6 @@ docker compose restart
 
 ## Related Documentation
 
-- [Common Issues](common-issues/index.md)
+- [Common Issues](common-issues/installation.md)
 - [Database Issues](common-issues/database.md)
 - [AI Model Issues](common-issues/ai-models.md)
diff --git a/docs/user-guide/documents/document-groups.md b/docs/user-guide/documents/document-groups.md
@@ -2,7 +2,7 @@
 
 Document Groups allow you to organize your library into logical collections, making it easier to manage large document sets and focus research on specific topics.
 
-![Document Groups View](../../images/user-guide/doc view document groups.png)
+<!-- Image not available: Document Groups View (doc view document groups.png) -->
 
 ## What are Document Groups?
 
@@ -79,7 +79,7 @@ Each group has:
 ## Group Operations
 
 ### Viewing Group Contents
-![Group Documents](../../images/user-guide/doc view document groups.png)
+<!-- Image not available: Group Documents (doc view document groups.png) -->
 
 Group view shows:
 - **Document List**: All documents in group
@@ -128,7 +128,7 @@ Groups provide focused context:
 - **Search Scope**: Search within group only
 
 ### Group Selection
-![Group Selection in Research](../../images/user-guide/doc view filters.png)
+<!-- Image not available: Group Selection in Research (doc view filters.png) -->
 
 In research interfaces:
 1. Click **"Select Group"** dropdown
@@ -304,7 +304,7 @@ groups or deleting groups, use the web interface or direct database operations.
 
 ## Next Steps
 
-- [Search Guide](search.md) - Search within groups
+- [Search Guide](overview.md#search) - Search within groups
 - [Research Overview](../research/overview.md) - Using groups in research
-- [Mission Settings](../research/mission-settings.md) - Group-based missions
+- [Mission Settings](../research/parameters.md) - Group-based missions
 - [Document Library](document-library.md) - Managing documents
diff --git a/docs/user-guide/documents/document-library.md b/docs/user-guide/documents/document-library.md
@@ -2,7 +2,7 @@
 
 The Document Library is your centralized repository for all uploaded documents. It provides comprehensive tools for viewing, organizing, searching, and managing your document collection.
 
-![Document Library View](../../images/user-guide/doc view all docs.png)
+<!-- Image not available: Document Library View (doc view all docs.png) -->
 
 ## Library Interface
 
@@ -26,7 +26,7 @@ Each document card shows:
 ## Viewing Documents
 
 ### Document Grid View
-![Document Grid](../../images/user-guide/doc view all docs.png)
+<!-- Image not available: Document Grid (doc view all docs.png) -->
 - **Visual Layout**: Card-based display
 - **Quick Preview**: Hover for summary
 - **Batch Selection**: Click to select multiple
@@ -43,7 +43,7 @@ Alternative compact display:
 
 ## Filtering Documents
 
-![Filter Options](../../images/user-guide/doc view filters.png)
+<!-- Image not available: Filter Options (doc view filters.png) -->
 
 ### Available Filters
 Filter your library by:
@@ -270,6 +270,6 @@ Tools for maintenance:
 ## Next Steps
 
 - [Document Groups](document-groups.md) - Organizing collections
-- [Search Guide](search.md) - Advanced search techniques
+- [Search Guide](overview.md#search) - Advanced search techniques
 - [Uploading](uploading.md) - Adding new documents
-- [Supported Formats](supported-formats.md) - File type details
+- [Supported Formats](uploading.md#supported-formats) - File type details
diff --git a/docs/user-guide/documents/overview.md b/docs/user-guide/documents/overview.md
@@ -2,7 +2,7 @@
 
 The document management system is the foundation of MAESTRO's research capabilities, allowing you to upload, organize, and search through your document library.
 
-![Document Library](../../images/user-guide/doc view all docs.png)
+<!-- Image not available: Document Library (doc view all docs.png) -->
 
 ## How Document Processing Works
 
@@ -166,5 +166,5 @@ du -sh maestro_backend/data/*
 
 - [Uploading Documents](uploading.md) - Detailed upload guide
 - [Document Groups](document-groups.md) - Organizing collections
-- [Search Guide](search.md) - Advanced search techniques
+- [Search Guide](overview.md#search) - Advanced search techniques
 - [CLI Commands](../../getting-started/installation/cli-commands.md) - Bulk operations
diff --git a/docs/user-guide/documents/uploading.md b/docs/user-guide/documents/uploading.md
@@ -2,7 +2,7 @@
 
 MAESTRO provides multiple ways to upload documents to your library, supporting various file formats and batch uploads. The system automatically processes documents for semantic search and research capabilities.
 
-![Drag and Drop Upload](../../images/user-guide/doc view drag and drop upload.png)
+<!-- Image not available: Drag and Drop Upload (doc view drag and drop upload.png) -->
 
 ## Upload Methods
 
@@ -285,5 +285,17 @@ If uploaded documents don't appear:
 
 - [Document Library](document-library.md) - Managing your documents
 - [Document Groups](document-groups.md) - Organizing collections
-- [Search](search.md) - Finding documents
-- [Supported Formats](supported-formats.md) - Format details
+- [Search](overview.md#search) - Finding documents
+- [Supported Formats](uploading.md#supported-formats) - Format details
+
+## Supported Formats
+
+MAESTRO supports the following document formats:
+
+- **PDF** (.pdf) - Portable Document Format
+- **Microsoft Word** (.docx, .doc) - Word documents
+- **Markdown** (.md, .markdown) - Markdown files
+- **Plain Text** (.txt) - Plain text files
+- **Rich Text Format** (.rtf) - RTF documents
+
+Documents are automatically processed and indexed for searching after upload.
diff --git a/docs/user-guide/index.md b/docs/user-guide/index.md
@@ -40,11 +40,11 @@ If you're new to MAESTRO, follow this recommended path:
     
     Set up your AI providers and models
 
--   :material-numeric-4-circle: **[Start Your First Chat](research/chat-interface.md)**
+-   :material-numeric-4-circle: **[Start Your First Chat](research/overview.md)**
     
     Begin exploring your documents with AI
 
--   :material-numeric-5-circle: **[Create a Mission](research/missions.md)**
+-   :material-numeric-5-circle: **[Create a Mission](research/overview.md)**
     
     Launch your first autonomous research mission
 
@@ -152,7 +152,7 @@ If you need assistance:
 
 - Check the **[FAQ](../troubleshooting/faq.md)** for common questions
 - Browse **[Troubleshooting](../troubleshooting/index.md)** for solutions
-- Visit our **[Community Forum](../community/discussions.md)**
+- Visit our **[Community Forum](https://github.com/murtaza-nasir/maestro/discussions)**
 - Report issues on **[GitHub](https://github.com/murtaza-nasir/maestro/issues)**
 
 ---
diff --git a/docs/user-guide/research/overview.md b/docs/user-guide/research/overview.md
@@ -28,7 +28,7 @@ MAESTRO's research system uses an agentic framework to gather information from w
 
 ## Starting a Research Session
 
-![Research Chat Interface](../../images/user-guide/Research view.png)
+<!-- Image not available: Research Chat Interface (Research view.png) -->
 
 ### Step 1: Initial Conversation
 
@@ -78,15 +78,15 @@ Once started, the chat interface is disabled and research begins.
 
 ## Monitoring Research Progress
 
-![Research Mission Interface](../../images/user-guide/Research view.png)
+<!-- Image not available: Research Mission Interface (Research view.png) -->
 
 ### The Mission Panel Tabs
 
 During research, monitor progress through four main tabs:
 
 #### 1. Plan Tab
 
-![Planning Phase](../../images/user-guide/Research view-plan outline.png)
+<!-- Image not available: Planning Phase (Research view-plan outline.png) -->
 
 Shows the research outline with sections and subsections:
 
@@ -116,7 +116,7 @@ Each agent entry shows:
 
 #### 3. Notes Tab
 
-![Research Notes](../../images/user-guide/Resarch view notes.png)
+<!-- Image not available: Research Notes (Resarch view notes.png) -->
 
 Collected research findings:
 
@@ -134,7 +134,7 @@ Filter and search capabilities:
 
 #### 4. Draft Tab
 
-![Draft Generation](../../images/user-guide/Research view draft.png)
+<!-- Image not available: Draft Generation (Research view draft.png) -->
 
 Final report generation:
 
@@ -201,7 +201,7 @@ Final report generation:
 
 ## Research Configuration
 
-![Mission Settings](../../images/user-guide/research view settings.png)
+<!-- Image not available: Mission Settings (research view settings.png) -->
 
 Research missions can be configured through the Settings tab or customized per mission. For a complete reference of all parameters, see the [Research Parameters Reference](parameters.md).
 
@@ -323,4 +323,4 @@ Visual breakdown showing:
 3. **Start Researching** - Begin with a simple topic to learn the interface
 4. **Optimize Settings** - Adjust parameters based on your needs
 
-For additional help, see the [FAQ](../../troubleshooting/faq.md) or visit our [Community Forum](../../community/discussions.md).
+For additional help, see the [FAQ](../../troubleshooting/faq.md) or visit our [Community Forum](https://github.com/murtaza-nasir/maestro/discussions).
diff --git a/docs/user-guide/research/parameters.md b/docs/user-guide/research/parameters.md
@@ -326,4 +326,4 @@ Parameters can be configured at multiple levels, with the following precedence (
 
 - [Research Overview](overview.md) - Understanding the research workflow
 - [AI Configuration](../settings/ai-config.md) - Model selection impacts
-- [Performance Tuning](../../troubleshooting/performance.md) - System optimization
+- [Performance Tuning](../../troubleshooting/common-issues/installation.md) - System optimization
diff --git a/docs/user-guide/settings/ai-config.md b/docs/user-guide/settings/ai-config.md
@@ -2,7 +2,7 @@
 
 Configure language model providers to power MAESTRO's research and writing capabilities.
 
-![AI Configuration Interface](../../assets/images/settings/ai-config.png)
+![AI Configuration Interface](//assets/images/settings/ai-config.png)
 
 For complete details on AI provider configuration, see the comprehensive [AI Provider Configuration Guide](../../getting-started/configuration/ai-providers.md).
 
diff --git a/docs/user-guide/settings/appearance.md b/docs/user-guide/settings/appearance.md
@@ -2,7 +2,7 @@
 
 Customize MAESTRO's visual appearance to suit your preferences.
 
-![Appearance Settings](../../assets/images/settings/appearance.png)
+![Appearance Settings](//assets/images/settings/appearance.png)
 
 ## Dark Mode
 
diff --git a/docs/user-guide/settings/profile.md b/docs/user-guide/settings/profile.md
@@ -2,7 +2,7 @@
 
 Manage your personal information and account security.
 
-![Profile Settings](../../assets/images/settings/profile.png)
+![Profile Settings](//assets/images/settings/profile.png)
 
 ## User Profile
 
diff --git a/docs/user-guide/settings/research-config.md b/docs/user-guide/settings/research-config.md
diff --git a/docs/user-guide/settings/search-config.md b/docs/user-guide/settings/search-config.md
diff --git a/docs/user-guide/settings/web-fetch-config.md b/docs/user-guide/settings/web-fetch-config.md
diff --git a/docs/user-guide/writing/overview.md b/docs/user-guide/writing/overview.md
diff --git a/fix_docs_comprehensive.py b/fix_docs_comprehensive.py
diff --git a/fix_docs_links.py b/fix_docs_links.py
