Skip to content

Consolidate documentation: remove redundancies and fix missing AI models coverage #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VictoKu1 merged 3 commits into from
Dec 23, 2025
Merged

Consolidate documentation: remove redundancies and fix missing AI models coverage #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dda27eb
Initial plan
Copilot Dec 23, 2025
fdb7936
Remove redundant GIT_REPOS_IMPLEMENTATION.md and fix documentation is…
Copilot Dec 23, 2025
48b8ace
Add missing AI models documentation to USAGE.md
Copilot Dec 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 0 additions & 27 deletions data/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,30 +92,3 @@ When the main URL fails, the script tries alternatives in order. If an alternati
- [Git Repositories Documentation](../docs/GIT_REPOSITORIES.md)
- [Automatic Updates Documentation](../docs/AUTO_UPDATE.md)
- [Main README](../README.md)
1. The working alternative becomes the new main URL
2. The failed main URL is moved to the end of alternatives
3. Config file is automatically updated

Example:
```json
{
"wget": {
"url": "-c https://example.com/file.zip",
"updateFile": false,
"downloaded": false,
"alternative": [
"https://example.com/file.zip",
"--timeout=30 -c https://example.com/file.zip"
]
}
}
```

## Usage

Download sources using:
```bash
python3 scripts/download_manual_sources.py
```

For more details, see [docs/MANUAL_SOURCES.md](../docs/MANUAL_SOURCES.md)
215 changes: 0 additions & 215 deletions docs/GIT_REPOS_IMPLEMENTATION.md
View file
Open in desktop

This file was deleted.

15 changes: 15 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ Welcome to the comprehensive documentation for EmergencyStorage! This documentat
- Configuration templates
- Common clone arguments

- **[AI Models Quick Reference](AI_MODELS_QUICK_REF.md)** - Quick AI models management
- Quick commands
- Configuration examples
- Model sizes and troubleshooting

### Understanding the System

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

- **[AI Models](AI_MODELS.md)** - Download and manage local AI models using Ollama
- Automatic Ollama installation
- Supported models and sizes
- Configuration and usage
- Storage management and portability
- Troubleshooting

- **[Mirror System](MIRROR_SYSTEM.md)** - Dynamic mirror management
- How automatic mirror updates work
- Manual mirror updates
Expand Down Expand Up @@ -142,6 +154,9 @@ Welcome to the comprehensive documentation for EmergencyStorage! This documentat
**...manage Git repositories**
→ Read [Git Repositories](GIT_REPOSITORIES.md) or [Quick Reference](GIT_REPOSITORIES_QUICK_REF.md)

**...download and use AI models offline**
→ Read [AI Models](AI_MODELS.md) or [Quick Reference](AI_MODELS_QUICK_REF.md)

## 📝 Additional Resources

- **[Main README](../README.md)** - Project overview and quick start
Expand Down
9 changes: 7 additions & 2 deletions docs/USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The main `emergency_storage.sh` script coordinates all individual scripts and pr

### Available Sources

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

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

# Advanced: Explicitly download everything to external drive (includes git repos)
# Advanced: Download AI models only
./emergency_storage.sh --models /mnt/external_drive

# Advanced: Explicitly download everything to external drive (includes git repos and AI models)
./emergency_storage.sh --all /mnt/external_drive

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

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