@tecet/ollm 0.1.4 → 0.1.5

package/docs/LLM Models/LLM_Index.md

@@ -1,701 +0,0 @@
-# Model Management Documentation Index
-
-**Complete Index with Summaries**
-
-This index provides a comprehensive overview of all Model Management documentation with summaries, line counts, and navigation.
-
----
-
-## 📚 Quick Navigation
-
-- [Main Documentation](#main-documentation)
-- [Routing System](#routing-system)
-- [Memory System](#memory-system)
-- [Template System](#template-system)
-- [Project Profiles](#project-profiles)
-- [API Reference](#api-reference)
-- [Documentation by Audience](#documentation-by-audience)
-- [Documentation by Topic](#documentation-by-topic)
-- [Documentation Status](#documentation-status)
-
----
-
-## Main Documentation
-
-### [Main README](3%20projects/OLLM%20CLI/LLM%20Models/README.md)
-
-**Overview and Navigation Guide**
-
-The main entry point for Model Management documentation. Provides an overview of all features, quick links to guides, and learning paths for different skill levels.
-
-**Topics:** Overview, Features, Navigation, Learning Paths, Quick Links  
-**Audience:** All users  
-**Length:** ~400 lines
-
-**Key Sections:**
-
-- What is Model Management
-- Documentation structure
-- Learning paths (Beginner, Intermediate, Advanced)
-- Common use cases
-- Troubleshooting
-
----
-
-### [Getting Started Guide](3%20projects/OLLM%20CLI/LLM%20Models/getting-started.md)
-
-**Quick Start Guide**
-
-Step-by-step guide to get started with model management, routing, memory, templates, and project profiles. Covers basic operations and common workflows.
-
-**Topics:** Quick Start, Basic Operations, Configuration, Examples  
-**Audience:** New users  
-**Length:** ~600 lines
-
-**Key Sections:**
-
-- Prerequisites
-- Quick start (5 minutes)
-- Basic model management
-- Using model routing
-- Working with memory
-- Using templates
-- Project profiles
-- Next steps
-
----
-
-### [Model Commands Reference](Models_commands.md)
-
-**Complete CLI Command Reference**
-
-Comprehensive reference for all model management commands. Includes syntax, examples, and detailed explanations for every command.
-
-**Topics:** Commands, Syntax, Examples, Options  
-**Audience:** All users  
-**Length:** ~800 lines
-
-**Key Sections:**
-
-- Model commands (/model list, pull, delete, info, use, keep, unload)
-- Memory commands (/memory list, add, search, forget, clear)
-- Template commands (/template list, use, create, delete)
-- Project commands (/project detect, use, init)
-- Comparison commands (/compare)
-- Configuration commands (/config show, set, reset)
-
----
-
-### [Model Architecture](Models_architecture.md)
-
-**System Architecture and Design**
-
-Detailed technical documentation of the Model Management system architecture. Covers all services, data models, and interactions.
-
-**Topics:** Architecture, Services, Data Models, Interactions  
-**Audience:** Developers  
-**Length:** ~1,200 lines
-
-**Key Sections:**
-
-- High-level architecture
-- Component interaction flows
-- Service interfaces
-- Data models
-- Correctness properties
-- Error handling
-- Testing strategy
-
----
-
-### [Model Compatibility](model-compatibility.md)
-
-**Model Compatibility Matrix**
-
-Comprehensive compatibility information for various LLM models tested with OLLM CLI. Documents which features work with which models, known issues, workarounds, and recommendations.
-
-**Topics:** Compatibility, Testing, Model Selection, Known Issues  
-**Audience:** All users, developers  
-**Length:** ~600 lines
-
-**Key Sections:**
-
-- Model categories (general-purpose, code-specialized, small/fast)
-- Detailed compatibility results per model
-- Model selection guide by use case
-- Model selection by resource constraints
-- Known issues and workarounds
-- Testing methodology
-
----
-
-### [Model Configuration](Models_configuration.md)
-
-**Configuration Guide**
-
-Complete guide to configuring model management, routing, memory, templates, and project profiles. Includes all configuration options and examples.
-
-**Topics:** Configuration, Options, Settings, Examples  
-**Audience:** All users  
-**Length:** ~600 lines
-
-**Key Sections:**
-
-- Global configuration
-- Project configuration
-- Environment variables
-- Model settings
-- Routing configuration
-- Memory settings
-- Template directories
-- Project profiles
-- Options validation
-
----
-
-## Routing System
-
-### [Routing README](3%20projects/OLLM%20CLI/LLM%20Models/routing/README.md)
-
-**Routing System Overview**
-
-Overview of the intelligent model routing system. Explains how routing works, profiles, and selection algorithm.
-
-**Topics:** Routing, Profiles, Selection, Configuration  
-**Audience:** All users  
-**Length:** ~300 lines
-
----
-
-### [Routing User Guide](3%20projects/OLLM%20CLI/LLM%20Models/routing/user-guide.md)
-
-**Using Model Routing**
-
-Practical guide to using model routing. Covers enabling routing, selecting profiles, and configuring overrides.
-
-**Topics:** Usage, Profiles, Configuration, Examples  
-**Audience:** Users  
-**Length:** ~400 lines
-
-**Key Sections:**
-
-- What is model routing
-- Enabling routing
-- Routing profiles (fast, general, code, creative)
-- Profile overrides
-- Manual override
-- Troubleshooting
-
----
-
-### [Routing Development Guide](3%20projects/OLLM%20CLI/LLM%20Models/routing/development-guide.md)
-
-**Creating Custom Routing**
-
-Guide for developers creating custom routing profiles and extending the routing system.
-
-**Topics:** Development, Custom Profiles, Extension  
-**Audience:** Developers  
-**Length:** ~500 lines
-
-**Key Sections:**
-
-- Selection algorithm
-- Creating custom profiles
-- Model database
-- Capability detection
-- Testing routing
-
----
-
-### [Profiles Reference](profiles-reference.md)
-
-**Routing Profiles Reference**
-
-Complete reference for all built-in routing profiles with detailed specifications.
-
-**Topics:** Profiles, Specifications, Criteria  
-**Audience:** All users  
-**Length:** ~300 lines
-
-**Key Sections:**
-
-- Fast profile
-- General profile
-- Code profile
-- Creative profile
-- Profile specifications
-
----
-
-## Memory System
-
-### [Memory README](3%20projects/OLLM%20CLI/LLM%20Models/memory/README.md)
-
-**Memory System Overview**
-
-Overview of the cross-session memory system. Explains how memory works, storage, and injection.
-
-**Topics:** Memory, Storage, Injection, Persistence  
-**Audience:** All users  
-**Length:** ~250 lines
-
----
-
-### [Memory User Guide](3%20projects/OLLM%20CLI/LLM%20Models/memory/user-guide.md)
-
-**Using Memory**
-
-Practical guide to using the memory system. Covers adding, searching, and managing memories.
-
-**Topics:** Usage, Commands, Examples, Best Practices  
-**Audience:** Users  
-**Length:** ~400 lines
-
-**Key Sections:**
-
-- What is memory
-- Adding memories
-- Listing and searching
-- Forgetting memories
-- LLM-initiated memory
-- Memory categories
-- Token budget
-- Best practices
-
----
-
-### [Memory API Reference](api-reference.md)
-
-**Memory Service API**
-
-Technical API reference for the Memory Service. Covers all methods, interfaces, and data structures.
-
-**Topics:** API, Methods, Interfaces, Data Structures  
-**Audience:** Developers  
-**Length:** ~400 lines
-
-**Key Sections:**
-
-- MemoryService interface
-- MemoryEntry structure
-- CRUD operations
-- System prompt injection
-- Persistence
-- Token budget management
-
----
-
-## Template System
-
-### [Templates README](3%20projects/OLLM%20CLI/LLM%20Models/templates/README.md)
-
-**Template System Overview**
-
-Overview of the prompt template system. Explains how templates work, variables, and substitution.
-
-**Topics:** Templates, Variables, Substitution, Storage  
-**Audience:** All users  
-**Length:** ~250 lines
-
----
-
-### [Templates User Guide](3%20projects/OLLM%20CLI/LLM%20Models/templates/user-guide.md)
-
-**Using Templates**
-
-Practical guide to using prompt templates. Covers listing, using, and creating templates.
-
-**Topics:** Usage, Commands, Examples, Best Practices  
-**Audience:** Users  
-**Length:** ~400 lines
-
-**Key Sections:**
-
-- What are templates
-- Listing templates
-- Using templates
-- Variable substitution
-- Creating templates
-- Template format (YAML)
-- Template locations
-- Best practices
-
----
-
-### [Template Reference](template-reference.md)
-
-**Template Format Reference**
-
-Complete reference for template format, variables, and syntax.
-
-**Topics:** Format, Variables, Syntax, Examples  
-**Audience:** All users  
-**Length:** ~400 lines
-
-**Key Sections:**
-
-- YAML format
-- Variable syntax
-- Required vs optional variables
-- Default values
-- Template metadata
-- Examples
-
----
-
-## Project Profiles
-
-### [Profiles README](3%20projects/OLLM%20CLI/LLM%20Models/profiles/README.md)
-
-**Project Profiles Overview**
-
-Overview of the project profile system. Explains auto-detection, built-in profiles, and configuration.
-
-**Topics:** Profiles, Detection, Configuration, Settings  
-**Audience:** All users  
-**Length:** ~250 lines
-
----
-
-### [Profiles User Guide](3%20projects/OLLM%20CLI/LLM%20Models/profiles/user-guide.md)
-
-**Using Project Profiles**
-
-Practical guide to using project profiles. Covers detection, selection, and initialization.
-
-**Topics:** Usage, Commands, Examples, Configuration  
-**Audience:** Users  
-**Length:** ~400 lines
-
-**Key Sections:**
-
-- What are project profiles
-- Auto-detection
-- Using profiles
-- Initializing projects
-- Project configuration
-- Settings precedence
-- Best practices
-
----
-
-### [Built-in Profiles](built-in-profiles.md)
-
-**Built-in Profiles Reference**
-
-Complete reference for all built-in project profiles with specifications.
-
-**Topics:** Profiles, Specifications, Settings  
-**Audience:** All users  
-**Length:** ~300 lines
-
-**Key Sections:**
-
-- TypeScript profile
-- Python profile
-- Rust profile
-- Go profile
-- Documentation profile
-- Profile specifications
-
----
-
-## Reference Materials
-
-### [Ollama Models Reference](ollama-models.md)
-
-**Complete Ollama Models Guide**
-
-Comprehensive reference for Ollama-compatible models including context windows, VRAM requirements, tool calling support, quantization guide, and performance benchmarks.
-
-**Topics:** Models, VRAM, Quantization, Performance, Tool Calling  
-**Audience:** All users  
-**Length:** ~600 lines
-
-**Key Sections:**
-
-- Context window fundamentals
-- VRAM requirements and calculations
-- Model selection matrix (by VRAM and use case)
-- Tool calling support tiers (Tier 1, 2, 3)
-- Quantization guide and recommendations
-- Configuration examples
-- Performance benchmarks
-- Troubleshooting
-
----
-
-## API Reference
-
-### [API README](3%20projects/OLLM%20CLI/LLM%20Models/api/README.md)
-
-**API Overview**
-
-Overview of all Model Management APIs. Provides navigation to detailed API references.
-
-**Topics:** APIs, Services, Interfaces  
-**Audience:** Developers  
-**Length:** ~200 lines
-
----
-
-### [Model Management Service API](model-management-service.md)
-
-**ModelManagementService API**
-
-Complete API reference for the Model Management Service.
-
-**Topics:** API, Methods, Interfaces, Examples  
-**Audience:** Developers  
-**Length:** ~500 lines
-
-**Key Sections:**
-
-- Interface definition
-- Core operations (list, pull, delete, info)
-- Keep-alive management
-- Cache management
-- Error handling
-- Examples
-
----
-
-### [Model Router API](model-router.md)
-
-**ModelRouter API**
-
-Complete API reference for the Model Router.
-
-**Topics:** API, Methods, Interfaces, Examples  
-**Audience:** Developers  
-**Length:** ~400 lines
-
-**Key Sections:**
-
-- Interface definition
-- Selection algorithm
-- Profile management
-- Model validation
-- Examples
-
----
-
-### [Memory Service API](memory-service.md)
-
-**MemoryService API**
-
-Complete API reference for the Memory Service.
-
-**Topics:** API, Methods, Interfaces, Examples  
-**Audience:** Developers  
-**Length:** ~400 lines
-
-**Key Sections:**
-
-- Interface definition
-- CRUD operations
-- System prompt injection
-- Persistence
-- Examples
-
----
-
-### [Template Service API](template-service.md)
-
-**TemplateService API**
-
-Complete API reference for the Template Service.
-
-**Topics:** API, Methods, Interfaces, Examples  
-**Audience:** Developers  
-**Length:** ~400 lines
-
-**Key Sections:**
-
-- Interface definition
-- Template management
-- Variable substitution
-- Persistence
-- Examples
-
----
-
-### [Project Profile Service API](project-profile-service.md)
-
-**ProjectProfileService API**
-
-Complete API reference for the Project Profile Service.
-
-**Topics:** API, Methods, Interfaces, Examples  
-**Audience:** Developers  
-**Length:** ~400 lines
-
-**Key Sections:**
-
-- Interface definition
-- Profile detection
-- Profile application
-- Project initialization
-- Examples
-
----
-
-## Documentation by Audience
-
-### For New Users
-
-1. [Main README](3%20projects/OLLM%20CLI/LLM%20Models/README.md) - Start here
-2. [Getting Started](3%20projects/OLLM%20CLI/LLM%20Models/getting-started.md) - Quick start guide
-3. [Model Commands](Models_commands.md) - Command reference
-4. [Memory User Guide](3%20projects/OLLM%20CLI/LLM%20Models/memory/user-guide.md) - Using memory
-5. [Templates User Guide](3%20projects/OLLM%20CLI/LLM%20Models/templates/user-guide.md) - Using templates
-
-### For Regular Users
-
-1. [Configuration Guide](Models_configuration.md) - Configuration options
-2. [Routing User Guide](3%20projects/OLLM%20CLI/LLM%20Models/routing/user-guide.md) - Using routing
-3. [Profiles User Guide](3%20projects/OLLM%20CLI/LLM%20Models/profiles/user-guide.md) - Using profiles
-4. [Profiles Reference](profiles-reference.md) - Routing profiles
-5. [Template Reference](template-reference.md) - Template format
-
-### For Developers
-
-1. [Model Architecture](Models_architecture.md) - System architecture
-2. [Routing Development Guide](3%20projects/OLLM%20CLI/LLM%20Models/routing/development-guide.md) - Custom routing
-3. [API Reference](api/) - API documentation
-4. [Model Management Service API](model-management-service.md) - Service API
-5. [Model Router API](model-router.md) - Router API
-
----
-
-## Documentation by Topic
-
-### Model Lifecycle
-
-- [Getting Started - Basic Model Management](3%20projects/OLLM%20CLI/LLM%20Models/getting-started.md#basic-model-management)
-- [Model Commands](Models_commands.md#model-commands)
-- [Model Management Service API](model-management-service.md)
-
-### Model Routing
-
-- [Routing README](3%20projects/OLLM%20CLI/LLM%20Models/routing/README.md)
-- [Routing User Guide](3%20projects/OLLM%20CLI/LLM%20Models/routing/user-guide.md)
-- [Routing Development Guide](3%20projects/OLLM%20CLI/LLM%20Models/routing/development-guide.md)
-- [Profiles Reference](profiles-reference.md)
-- [Model Router API](model-router.md)
-
-### Memory System
-
-- [Memory README](3%20projects/OLLM%20CLI/LLM%20Models/memory/README.md)
-- [Memory User Guide](3%20projects/OLLM%20CLI/LLM%20Models/memory/user-guide.md)
-- [Memory API Reference](api-reference.md)
-- [Memory Service API](memory-service.md)
-
-### Template System
-
-- [Templates README](3%20projects/OLLM%20CLI/LLM%20Models/templates/README.md)
-- [Templates User Guide](3%20projects/OLLM%20CLI/LLM%20Models/templates/user-guide.md)
-- [Template Reference](template-reference.md)
-- [Template Service API](template-service.md)
-
-### Project Profiles
-
-- [Profiles README](3%20projects/OLLM%20CLI/LLM%20Models/profiles/README.md)
-- [Profiles User Guide](3%20projects/OLLM%20CLI/LLM%20Models/profiles/user-guide.md)
-- [Built-in Profiles](built-in-profiles.md)
-- [Project Profile Service API](project-profile-service.md)
-
-### Configuration
-
-- [Configuration Guide](Models_configuration.md)
-- [Getting Started - Configuration](3%20projects/OLLM%20CLI/LLM%20Models/getting-started.md#configuration)
-- [Model Commands - Configuration](Models_commands.md#configuration-commands)
-
----
-
-## Documentation Status
-
-### Completed ✅
-
-**Main Documentation (5 files):**
-
-- ✅ README.md (400 lines)
-- ✅ getting-started.md (600 lines)
-- ✅ Models_commands.md (800 lines)
-- ✅ Models_architecture.md (1,200 lines)
-- ✅ Models_configuration.md (600 lines)
-
-**Routing Documentation (4 files):**
-
-- ✅ routing/README.md (300 lines)
-- ✅ routing/user-guide.md (400 lines)
-- ✅ routing/development-guide.md (500 lines)
-- ✅ routing/profiles-reference.md (300 lines)
-
-**Memory Documentation (3 files):**
-
-- ✅ memory/README.md (250 lines)
-- ✅ memory/user-guide.md (400 lines)
-- ✅ memory/api-reference.md (400 lines)
-
-**Template Documentation (3 files):**
-
-- ✅ templates/README.md (250 lines)
-- ✅ templates/user-guide.md (400 lines)
-- ✅ templates/template-reference.md (400 lines)
-
-**Profile Documentation (3 files):**
-
-- ✅ profiles/README.md (250 lines)
-- ✅ profiles/user-guide.md (400 lines)
-- ✅ profiles/built-in-profiles.md (300 lines)
-
-**API Documentation (6 files):**
-
-- ✅ api/README.md (200 lines)
-- ✅ api/model-management-service.md (500 lines)
-- ✅ api/model-router.md (400 lines)
-- ✅ api/memory-service.md (400 lines)
-- ✅ api/template-service.md (400 lines)
-- ✅ api/project-profile-service.md (400 lines)
-
-### Summary
-
-**Total Files:** 24  
-**Total Lines:** ~10,000  
-**Completion:** 100%
-
-**Documentation Coverage:**
-
-- ✅ User guides
-- ✅ Developer guides
-- ✅ API reference
-- ✅ Command reference
-- ✅ Configuration guide
-- ✅ Architecture documentation
-- ✅ Examples and tutorials
-
----
-
-## Related Documentation
-
-### OLLM CLI Documentation
-
-- [Main Documentation](../)
-- [Context Management](../Context/)
-- [MCP Integration](../MCP/)
-- [Configuration](../UI&Settings/Configuration.md)
-- [Troubleshooting](../Troubleshooting.md)
-
-### Development Documentation
-
-- Development Documentation (../../.dev/Models/)
-- Implementation Progress (../../.dev/Models/development/implementation-progress.md)
-- Specifications (../../.kiro/specs/stage-07-model-management/)
-
----
-
-**Last Updated:** 2026-01-16  
-**Version:** 0.1.0  
-**Status:** Complete