mirror of
https://github.com/hcengineering/platform.git
synced 2026-08-31 12:19:47 +02:00
139 lines
4.6 KiB
Markdown
139 lines
4.6 KiB
Markdown
# Huly Network Documentation
|
|
|
|
Welcome to the Huly Virtual Network documentation! This directory contains comprehensive guides for building distributed systems with Huly Network.
|
|
|
|
## 📚 Documentation Index
|
|
|
|
### Getting Started
|
|
|
|
- **[Quick Start Guide](QUICKSTART.md)** - Get up and running in 5 minutes
|
|
- **[Installation Guide](INSTALLATION.md)** - Detailed installation instructions
|
|
- **[Core Concepts](CORE_CONCEPTS.md)** - Understanding the architecture
|
|
|
|
### Guides
|
|
|
|
- **[Container Development Guide](CONTAINER_DEVELOPMENT.md)** - Building containers
|
|
- **[Agent Development Guide](AGENT_DEVELOPMENT.md)** - Creating and managing agents
|
|
- **[Client Usage Guide](CLIENT_USAGE.md)** - Connecting and using the network
|
|
- **[Network Server Setup](NETWORK_SERVER.md)** - Running the network server
|
|
|
|
### Advanced Topics
|
|
|
|
- **[High Availability (HA) Stateless Containers](HA_STATELESS_CONTAINERS.md)** - Automatic failover
|
|
- **[Quick Start: HA](QUICKSTART_HA.md)** - HA in 5 minutes
|
|
- **[Multi-Tenant Architectures](MULTI_TENANT.md)** - Building SaaS applications
|
|
- **[Performance Tuning](PERFORMANCE.md)** - Optimization strategies
|
|
- **[Error Handling Best Practices](ERROR_HANDLING.md)** - Robust error handling
|
|
|
|
### Production
|
|
|
|
- **[Production Deployment Guide](PRODUCTION_DEPLOYMENT.md)** - Going to production
|
|
- **[Monitoring and Observability](MONITORING.md)** - Tracking system health
|
|
- **[Security Best Practices](SECURITY.md)** - Securing your deployment
|
|
- **[Troubleshooting Guide](TROUBLESHOOTING.md)** - Common issues and solutions
|
|
|
|
### API Reference
|
|
|
|
- **[Core API Reference](API_CORE.md)** - Core package APIs
|
|
- **[Client API Reference](API_CLIENT.md)** - Client package APIs
|
|
- **[Server API Reference](API_SERVER.md)** - Server package APIs
|
|
- **[BackRPC API Reference](API_BACKRPC.md)** - Communication layer APIs
|
|
|
|
### Migration & Integration
|
|
|
|
- **[Migration from Other Systems](MIGRATION.md)** - Moving to Huly Network
|
|
- **[Integration Patterns](INTEGRATION.md)** - Integrating with existing systems
|
|
|
|
## 🎯 Quick Navigation
|
|
|
|
### I want to...
|
|
|
|
**Learn the basics**
|
|
→ Start with [Quick Start Guide](QUICKSTART.md) and [Core Concepts](CORE_CONCEPTS.md)
|
|
|
|
**Build my first container**
|
|
→ Read [Container Development Guide](CONTAINER_DEVELOPMENT.md)
|
|
|
|
**Deploy to production**
|
|
→ Follow [Production Deployment Guide](PRODUCTION_DEPLOYMENT.md)
|
|
|
|
**Implement high availability**
|
|
→ See [HA Stateless Containers](HA_STATELESS_CONTAINERS.md) and [Quick Start: HA](QUICKSTART_HA.md)
|
|
|
|
**Build a SaaS application**
|
|
→ Check [Multi-Tenant Architectures](MULTI_TENANT.md)
|
|
|
|
**Troubleshoot issues**
|
|
→ Visit [Troubleshooting Guide](TROUBLESHOOTING.md)
|
|
|
|
**Optimize performance**
|
|
→ Read [Performance Tuning](PERFORMANCE.md)
|
|
|
|
## 📖 Reading Order
|
|
|
|
### For Beginners
|
|
|
|
1. [Quick Start Guide](QUICKSTART.md)
|
|
2. [Core Concepts](CORE_CONCEPTS.md)
|
|
3. [Container Development Guide](CONTAINER_DEVELOPMENT.md)
|
|
4. [Client Usage Guide](CLIENT_USAGE.md)
|
|
|
|
### For Application Developers
|
|
|
|
1. [Container Development Guide](CONTAINER_DEVELOPMENT.md)
|
|
2. [Agent Development Guide](AGENT_DEVELOPMENT.md)
|
|
3. [Multi-Tenant Architectures](MULTI_TENANT.md)
|
|
4. [Error Handling Best Practices](ERROR_HANDLING.md)
|
|
|
|
### For DevOps Engineers
|
|
|
|
1. [Installation Guide](INSTALLATION.md)
|
|
2. [Network Server Setup](NETWORK_SERVER.md)
|
|
3. [Production Deployment Guide](PRODUCTION_DEPLOYMENT.md)
|
|
4. [Monitoring and Observability](MONITORING.md)
|
|
5. [Security Best Practices](SECURITY.md)
|
|
|
|
### For System Architects
|
|
|
|
1. [Core Concepts](CORE_CONCEPTS.md)
|
|
2. [Performance Tuning](PERFORMANCE.md)
|
|
3. [High Availability](HA_STATELESS_CONTAINERS.md)
|
|
4. [Integration Patterns](INTEGRATION.md)
|
|
|
|
## 🔗 External Resources
|
|
|
|
- [Main Repository](https://github.com/hcengineering/huly.net)
|
|
- [Examples Directory](../examples/)
|
|
- [ZeroMQ Documentation](https://zeromq.org/documentation/)
|
|
- [Huly Platform](https://github.com/hcengineering/platform)
|
|
|
|
## 🤝 Contributing to Documentation
|
|
|
|
We welcome contributions to improve our documentation! Please:
|
|
|
|
1. Check existing docs to avoid duplication
|
|
2. Follow the same structure and formatting
|
|
3. Include code examples where appropriate
|
|
4. Test all code examples before submitting
|
|
5. Update this index when adding new documents
|
|
|
|
## 📝 Documentation Standards
|
|
|
|
- Use Markdown format
|
|
- Include a table of contents for long documents
|
|
- Add code examples with syntax highlighting
|
|
- Include diagrams using Mermaid when helpful
|
|
- Keep language clear and concise
|
|
- Provide both conceptual and practical information
|
|
|
|
## 💬 Getting Help
|
|
|
|
- Check the [Troubleshooting Guide](TROUBLESHOOTING.md)
|
|
- Review the [Examples](../examples/)
|
|
- Open an issue on GitHub
|
|
- Join our community discussions
|
|
|
|
---
|
|
|
|
Last updated: October 2025
|