@tecet/ollm 0.1.3

package/docs/Prompts System/Index.md

@@ -0,0 +1,223 @@
+# Prompts System Documentation Index
+
+**Quick Reference with Links**
+
+This index provides quick navigation to all Prompts System documentation with brief descriptions.
+
+---
+
+## 📚 Core Documentation
+
+### [README.md](README.md)
+
+**Overview and Navigation Guide**
+
+Main entry point for Prompts System documentation. Provides overview of system prompts, templates, routing, and common use cases.
+
+**Topics:** Overview, System Prompts, Templates, Routing  
+**Audience:** All users
+
+---
+
+### [Architecture](Architecture.md)
+
+**System Architecture and Design** ⏳ Coming Soon
+
+Complete technical documentation of the Prompts System architecture. Will cover prompt construction, template engine, routing logic, and optimization strategies.
+
+**Topics:** Architecture, Components, Prompt Assembly, Optimization  
+**Audience:** Developers, architects
+
+**Planned Sections:**
+
+- System overview and architecture
+- Prompt construction pipeline
+- Template engine design
+- Routing and mode system
+- Optimization strategies
+- Component interactions
+
+---
+
+### [System Prompts](SystemPrompts.md)
+
+**System Prompt Construction**
+
+Comprehensive guide to system prompt construction. Explains how system prompts are built from components, what information is included, and how they're optimized.
+
+**Topics:** System Prompts, Construction, Components, Optimization  
+**Audience:** All users
+
+**Key Sections:**
+
+- System prompt components
+- Prompt assembly process
+- Tool description injection
+- Context information injection
+- Mode-specific instructions
+- Optimization techniques
+- Token management
+
+---
+
+### [Prompt Templates](PromptsTemplates.md)
+
+**Template System**
+
+Detailed guide to the prompt template system. Covers template types, variable substitution, composition, and creating custom templates.
+
+**Topics:** Templates, Variables, Composition, Custom Templates  
+**Audience:** All users
+
+**Key Sections:**
+
+- Template types and structure
+- Variable substitution syntax
+- Template composition
+- Built-in templates
+- Creating custom templates
+- Template management
+- Best practices
+
+---
+
+### [Prompt Routing](PromptsRouting.md)
+
+**Routing and Modes**
+
+Guide to prompt routing and mode system. Explains how prompts are selected based on context, mode switching, and mode-specific behavior.
+
+**Topics:** Routing, Modes, Selection, Context-Aware  
+**Audience:** All users
+
+**Key Sections:**
+
+- Routing modes (chat, code, planning, review)
+- Mode detection and selection
+- Mode-specific prompts
+- Mode switching
+- Context-aware routing
+- Custom modes
+- Performance optimization
+
+---
+
+## 📖 Documentation by Topic
+
+### System Prompts
+
+- [System Prompts](SystemPrompts.md) - Complete guide
+- [README](README.md#system-prompts) - Overview
+- [Architecture](Architecture.md#prompt-construction) - Implementation (Coming Soon)
+
+### Templates
+
+- [Prompt Templates](PromptsTemplates.md) - Complete guide
+- [README](README.md#prompt-templates) - Overview
+- [Architecture](Architecture.md#template-engine) - Implementation (Coming Soon)
+
+### Routing
+
+- [Prompt Routing](PromptsRouting.md) - Complete guide
+- [README](README.md#prompt-routing) - Overview
+- [Architecture](Architecture.md#routing-system) - Implementation (Coming Soon)
+
+### Configuration
+
+- [README](README.md#configuration) - Configuration overview
+- [System Prompts](SystemPrompts.md#configuration) - Prompt settings
+- [Prompt Templates](PromptsTemplates.md#configuration) - Template settings
+- [Prompt Routing](PromptsRouting.md#configuration) - Routing settings
+
+---
+
+## 📖 Documentation by Audience
+
+### For New Users
+
+1. [README](README.md) - Start here
+2. [System Prompts](SystemPrompts.md) - Understanding prompts
+3. [Prompt Routing](PromptsRouting.md) - Using modes
+
+### For Regular Users
+
+1. [Prompt Templates](PromptsTemplates.md) - Using templates
+2. [Prompt Routing](PromptsRouting.md#custom-modes) - Custom modes
+3. [README](README.md#configuration) - Configuration
+
+### For Developers
+
+1. [Architecture](Architecture.md) - System design (Coming Soon)
+2. [System Prompts](SystemPrompts.md#optimization) - Optimization
+3. [Prompt Templates](PromptsTemplates.md#advanced) - Advanced templates
+
+---
+
+## 🔗 Related Documentation
+
+### Core Systems
+
+- [Context Management](../Context/ContextManagment.md) - Context system
+- [Tools System](../Tools/README.md) - Tool execution
+- [Model Management](../LLM%20Models/README.md) - Model selection
+
+### Commands
+
+- [Prompt Commands](../UI&Settings/Commands.md#prompt-commands) - CLI commands
+- [Template Commands](../UI&Settings/Commands.md#template-commands) - Template management
+- [Mode Commands](../UI&Settings/Commands.md#mode-commands) - Mode switching
+
+### Developer Resources
+
+- Knowledge DB: `dev_PromptSystem.md` - Architecture details
+
+---
+
+## 📊 Documentation Status
+
+### Completed ✅
+
+| Document            | Status      |
+| ------------------- | ----------- |
+| README.md           | ✅ Complete |
+| Index.md            | ✅ Complete |
+| SystemPrompts.md    | ✅ Complete |
+| PromptsTemplates.md | ✅ Complete |
+| PromptsRouting.md   | ✅ Complete |
+
+### Planned ⏳
+
+| Document        | Status         |
+| --------------- | -------------- |
+| Architecture.md | ⏳ Coming Soon |
+
+**Overall Progress:** 83% complete (5/6 files)
+
+---
+
+## 🎯 Quick Links
+
+### Common Tasks
+
+- View system prompt → [System Prompts](SystemPrompts.md#viewing-prompts)
+- Use template → [Prompt Templates](PromptsTemplates.md#using-templates)
+- Switch mode → [Prompt Routing](PromptsRouting.md#switching-modes)
+- Create template → [Prompt Templates](PromptsTemplates.md#creating-templates)
+
+### Understanding Systems
+
+- How system prompts work → [System Prompts](SystemPrompts.md)
+- How templates work → [Prompt Templates](PromptsTemplates.md)
+- How routing works → [Prompt Routing](PromptsRouting.md)
+- System architecture → [Architecture](Architecture.md) (Coming Soon)
+
+### Configuration
+
+- System prompt settings → [README](README.md#system-prompt-settings)
+- Template settings → [README](README.md#template-settings)
+- Routing settings → [README](README.md#routing-settings)
+
+---
+
+**Last Updated:** January 26, 2026  
+**Version:** 0.1.0