Skip to content

Commit a691fa0

Browse files
authored
Merge pull request #26 from VictoKu1/copilot/fix-documentation-issues
Consolidate documentation: remove redundancies and fix missing AI models coverage
2 parents cfe563f + 48b8ace commit a691fa0

File tree

4 files changed

+22
-244
lines changed

4 files changed

+22
-244
lines changed

data/README.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -92,30 +92,3 @@ When the main URL fails, the script tries alternatives in order. If an alternati
9292
- [Git Repositories Documentation](../docs/GIT_REPOSITORIES.md)
9393
- [Automatic Updates Documentation](../docs/AUTO_UPDATE.md)
9494
- [Main README](../README.md)
95-
1. The working alternative becomes the new main URL
96-
2. The failed main URL is moved to the end of alternatives
97-
3. Config file is automatically updated
98-
99-
Example:
100-
```json
101-
{
102-
"wget": {
103-
"url": "-c https://example.com/file.zip",
104-
"updateFile": false,
105-
"downloaded": false,
106-
"alternative": [
107-
"https://example.com/file.zip",
108-
"--timeout=30 -c https://example.com/file.zip"
109-
]
110-
}
111-
}
112-
```
113-
114-
## Usage
115-
116-
Download sources using:
117-
```bash
118-
python3 scripts/download_manual_sources.py
119-
```
120-
121-
For more details, see [docs/MANUAL_SOURCES.md](../docs/MANUAL_SOURCES.md)

docs/GIT_REPOS_IMPLEMENTATION.md

Lines changed: 0 additions & 215 deletions
This file was deleted.

docs/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,11 @@ Welcome to the comprehensive documentation for EmergencyStorage! This documentat
5454
- Configuration templates
5555
- Common clone arguments
5656

57+
- **[AI Models Quick Reference](AI_MODELS_QUICK_REF.md)** - Quick AI models management
58+
- Quick commands
59+
- Configuration examples
60+
- Model sizes and troubleshooting
61+
5762
### Understanding the System
5863

5964
- **[Architecture](ARCHITECTURE.md)** - System design and structure
@@ -79,6 +84,13 @@ Welcome to the comprehensive documentation for EmergencyStorage! This documentat
7984
- Operations (clone, update, both)
8085
- Error handling and logging
8186

87+
- **[AI Models](AI_MODELS.md)** - Download and manage local AI models using Ollama
88+
- Automatic Ollama installation
89+
- Supported models and sizes
90+
- Configuration and usage
91+
- Storage management and portability
92+
- Troubleshooting
93+
8294
- **[Mirror System](MIRROR_SYSTEM.md)** - Dynamic mirror management
8395
- How automatic mirror updates work
8496
- Manual mirror updates
@@ -142,6 +154,9 @@ Welcome to the comprehensive documentation for EmergencyStorage! This documentat
142154
**...manage Git repositories**
143155
→ Read [Git Repositories](GIT_REPOSITORIES.md) or [Quick Reference](GIT_REPOSITORIES_QUICK_REF.md)
144156

157+
**...download and use AI models offline**
158+
→ Read [AI Models](AI_MODELS.md) or [Quick Reference](AI_MODELS_QUICK_REF.md)
159+
145160
## 📝 Additional Resources
146161

147162
- **[Main README](../README.md)** - Project overview and quick start

docs/USAGE.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The main `emergency_storage.sh` script coordinates all individual scripts and pr
2323

2424
### Available Sources
2525

26-
- `--all` - Download from all sources (default when no flags specified, includes git repositories, excludes manual-sources)
26+
- `--all` - Download from all sources (default when no flags specified, includes git repositories and AI models, excludes manual-sources)
2727
- `--kiwix` - Download Kiwix mirror only
2828
- `--openzim` - Download OpenZIM files only
2929
- `--openstreetmap` - Download OpenStreetMap data only
@@ -32,6 +32,7 @@ The main `emergency_storage.sh` script coordinates all individual scripts and pr
3232
- `--ia-movies` - Download Internet Archive movies collection only
3333
- `--ia-texts` - Download Internet Archive scientific texts only
3434
- `--git` - Clone/update Git repositories from JSON configuration
35+
- `--models` - Download AI models using Ollama (installs Ollama if needed)
3536
- `--manual-sources` - Download from manually configured JSON sources (must be selected explicitly, not part of --all)
3637

3738
### Examples
@@ -70,7 +71,10 @@ The main `emergency_storage.sh` script coordinates all individual scripts and pr
7071
# Advanced: Clone/update Git repositories only
7172
./emergency_storage.sh --git /mnt/external_drive
7273

73-
# Advanced: Explicitly download everything to external drive (includes git repos)
74+
# Advanced: Download AI models only
75+
./emergency_storage.sh --models /mnt/external_drive
76+
77+
# Advanced: Explicitly download everything to external drive (includes git repos and AI models)
7478
./emergency_storage.sh --all /mnt/external_drive
7579

7680
# Show help
@@ -93,6 +97,7 @@ chmod +x scripts/*.sh
9397
./scripts/ia-music.sh /mnt/external_drive # IA Music collection
9498
./scripts/ia-movies.sh /mnt/external_drive # IA Movies collection
9599
./scripts/ia-texts.sh /mnt/external_drive # IA Texts collection
100+
./scripts/models.sh /mnt/external_drive # AI models using Ollama
96101

97102
# Python scripts for Git repos and manual sources
98103
python3 scripts/download_git_repos.py --dest /mnt/external_drive/git_repos

0 commit comments

Comments
 (0)