Skip to content

Commit de7dc19

Browse files
author
Murtaza Nsair
committed
documentation fixes
1 parent f4bb2b2 commit de7dc19

28 files changed

+472
-659
lines changed

README.md

Lines changed: 33 additions & 603 deletions
Large diffs are not rendered by default.

docs/getting-started/configuration/ai-providers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Configure language model providers to power MAESTRO's research and writing capabilities.
44

5-
![AI Configuration Interface](../../assets/images/settings/ai-config.png)
5+
![AI Configuration Interface](//assets/images/settings/ai-config.png)
66

77
## Overview
88

docs/getting-started/configuration/environment-variables.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,4 +317,23 @@ ALLOW_CORS_WILDCARD=false
317317
- [AI Provider Configuration](ai-providers.md) - Configure LLMs
318318
- [Search Provider Configuration](search-providers.md) - Set up web search
319319
- [First Login](../first-login.md) - Initial setup guide
320-
- [Configuration Overview](overview.md) - General configuration guide
320+
- [Configuration Overview](overview.md) - General configuration guide
321+
322+
## Backup
323+
324+
To backup your MAESTRO installation:
325+
326+
1. **Database Backup**:
327+
```bash
328+
docker exec maestro-postgres pg_dump -U maestro_user maestro_db > backup.sql
329+
```
330+
331+
2. **Document Files Backup**:
332+
```bash
333+
tar -czf documents.tar.gz ./data/raw_files ./data/markdown_files
334+
```
335+
336+
3. **Vector Store Backup**:
337+
```bash
338+
tar -czf vector_store.tar.gz ./data/vector_store
339+
```

docs/getting-started/configuration/search-providers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Enable web search capabilities for MAESTRO's research agents to access current information from the internet.
44

5-
![Search Configuration Interface](../../assets/images/settings/search.png)
5+
![Search Configuration Interface](//assets/images/settings/search.png)
66

77
## Overview
88

docs/getting-started/configuration/web-fetch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Configure how MAESTRO fetches and processes full content from web pages discovered during research.
44

5-
![Web Fetch Configuration Interface](../../assets/images/settings/web-fetch.png)
5+
![Web Fetch Configuration Interface](//assets/images/settings/web-fetch.png)
66

77
## Overview
88

docs/getting-started/first-login.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ grep ADMIN_PASSWORD .env
4747

4848
### Step 2: Configure AI Provider
4949

50-
![AI Configuration](../assets/images/settings/ai-config.png)
50+
![AI Configuration](/assets/images/settings/ai-config.png)
5151

5252
1. Stay in Settings, click **AI Config** tab
5353
2. Select your AI Provider:
@@ -65,7 +65,7 @@ grep ADMIN_PASSWORD .env
6565

6666
### Step 3: Configure Search Provider (Optional)
6767

68-
![Search Configuration](../assets/images/settings/search.png)
68+
![Search Configuration](/assets/images/settings/search.png)
6969

7070
1. Click **Search** tab in Settings
7171
2. Select a search provider:
@@ -79,7 +79,7 @@ grep ADMIN_PASSWORD .env
7979

8080
### Step 4: Upload Your First Documents
8181

82-
![Document Library](../../images/01-document-library.png)
82+
<!-- Image not available: Document Library (01-document-library.png) -->
8383

8484
1. Navigate to **Documents** tab
8585
2. Create a Document Group and Select it from the sidebar
@@ -191,9 +191,9 @@ grep ADMIN_PASSWORD .env
191191

192192
### Documentation
193193

194-
- [User Guide](../../user-guide/index.md) - Complete feature guide
195-
- [Troubleshooting](../../troubleshooting/index.md) - Problem solving
196-
- [FAQ](../../troubleshooting/faq.md) - Common questions
194+
- [User Guide](../user-guide/index.md) - Complete feature guide
195+
- [Troubleshooting](../troubleshooting/index.md) - Problem solving
196+
- [FAQ](../troubleshooting/faq.md) - Common questions
197197

198198
### Community Support
199199

docs/getting-started/installation/cli-commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -370,4 +370,4 @@ docker compose logs maestro-backend --tail=100
370370
- [Database Management](database-reset.md) - Database operations
371371
- [User Guide](../../user-guide/index.md) - Using the web interface
372372
- [Troubleshooting](../../troubleshooting/index.md) - Common issues
373-
- [API Reference](../../api/index.md) - REST API documentation
373+
- [API Reference](#) - REST API documentation

docs/getting-started/installation/database-reset.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,4 +260,4 @@ docker system prune -a --volumes
260260

261261
- [CLI Usage Guide](cli-commands.md)
262262
- [Document Processing](../../user-guide/documents/overview.md)
263-
- [Backup Automation](../configuration/backup.md)
263+
- [Backup Automation](../configuration/environment-variables.md#backup)

docs/getting-started/installation/docker.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ docker stack deploy -c docker-compose.yml maestro
319319

320320
### Kubernetes
321321

322-
See [Kubernetes Deployment](../../deployment/kubernetes/helm-chart.md) for Helm chart installation.
322+
See [Kubernetes Deployment](../../deployment/local-llms.md) for Helm chart installation.
323323

324324
## Troubleshooting
325325

@@ -416,4 +416,4 @@ After successful installation:
416416
3. **[Upload Documents](../../user-guide/documents/uploading.md)** - Build your library
417417
4. **[Quick Start Guide](../quickstart.md)** - Start using MAESTRO
418418

419-
For additional help, see our [Troubleshooting Guide](../../troubleshooting/index.md) or visit the [Community Forum](../../community/discussions.md).
419+
For additional help, see our [Troubleshooting Guide](../../troubleshooting/index.md) or visit the [Community Forum](https://github.com/murtaza-nasir/maestro/discussions).

docs/troubleshooting/common-issues/ai-models.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Quick fixes for AI model configuration and API issues.
1414
4. Click "Test" button
1515
5. Models should populate automatically
1616

17-
![AI Config Model Selection](../../assets/images/troubleshooting/ai-config-model-selection.png)
17+
<!-- Image not available: AI Config Model Selection (ai-config-model-selection.png) -->
1818

1919
**If still empty:**
2020
```bash

0 commit comments

Comments
 (0)