mirror of
https://github.com/lordmathis/llamactl.git
synced 2025-11-06 00:54:23 +00:00
Create initial documentation structure
This commit is contained in:
41
docs/index.md
Normal file
41
docs/index.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# LlamaCtl Documentation
|
||||
|
||||
Welcome to the LlamaCtl documentation! LlamaCtl is a powerful management tool for Llama.cpp instances that provides both a web interface and REST API for managing large language models.
|
||||
|
||||
## What is LlamaCtl?
|
||||
|
||||
LlamaCtl is designed to simplify the deployment and management of Llama.cpp instances. It provides:
|
||||
|
||||
- **Instance Management**: Start, stop, and monitor multiple Llama.cpp instances
|
||||
- **Web UI**: User-friendly interface for managing your models
|
||||
- **REST API**: Programmatic access to all functionality
|
||||
- **Health Monitoring**: Real-time status and health checks
|
||||
- **Configuration Management**: Easy setup and configuration options
|
||||
|
||||
## Key Features
|
||||
|
||||
- 🚀 **Easy Setup**: Quick installation and configuration
|
||||
- 🌐 **Web Interface**: Intuitive web UI for model management
|
||||
- 🔧 **REST API**: Full API access for automation
|
||||
- 📊 **Monitoring**: Real-time health and status monitoring
|
||||
- 🔒 **Security**: Authentication and access control
|
||||
- 📱 **Responsive**: Works on desktop and mobile devices
|
||||
|
||||
## Quick Links
|
||||
|
||||
- [Installation Guide](getting-started/installation.md) - Get LlamaCtl up and running
|
||||
- [Quick Start](getting-started/quick-start.md) - Your first steps with LlamaCtl
|
||||
- [Web UI Guide](user-guide/web-ui.md) - Learn to use the web interface
|
||||
- [API Reference](user-guide/api-reference.md) - Complete API documentation
|
||||
|
||||
## Getting Help
|
||||
|
||||
If you need help or have questions:
|
||||
|
||||
- Check the [Troubleshooting](advanced/troubleshooting.md) guide
|
||||
- Visit our [GitHub repository](https://github.com/lordmathis/llamactl)
|
||||
- Read the [Contributing guide](development/contributing.md) to help improve LlamaCtl
|
||||
|
||||
---
|
||||
|
||||
Ready to get started? Head over to the [Installation Guide](getting-started/installation.md)!
|
||||
Reference in New Issue
Block a user