mirror of
https://github.com/hcengineering/platform.git
synced 2026-09-01 04:38:50 +02:00
Andrey Sobolev
b846307ae1
+ Change createAgent into serveAgent calls, previous one is still available. + Move tick mgr into client, and add auto disposable to properly close clients.
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 - Get up and running in 5 minutes
- Installation Guide - Detailed installation instructions
- Core Concepts - Understanding the architecture
Guides
- Container Development Guide - Building containers
- Agent Development Guide - Creating and managing agents
- Client Usage Guide - Connecting and using the network
- Network Server Setup - Running the network server
Advanced Topics
- High Availability (HA) Stateless Containers - Automatic failover
- Quick Start: HA - HA in 5 minutes
- Multi-Tenant Architectures - Building SaaS applications
- Performance Tuning - Optimization strategies
- Error Handling Best Practices - Robust error handling
Production
- Production Deployment Guide - Going to production
- Monitoring and Observability - Tracking system health
- Security Best Practices - Securing your deployment
- Troubleshooting Guide - Common issues and solutions
API Reference
- Core API Reference - Core package APIs
- Client API Reference - Client package APIs
- Server API Reference - Server package APIs
- BackRPC API Reference - Communication layer APIs
Migration & Integration
- Migration from Other Systems - Moving to Huly Network
- Integration Patterns - Integrating with existing systems
🎯 Quick Navigation
I want to...
Learn the basics → Start with Quick Start Guide and Core Concepts
Build my first container → Read Container Development Guide
Deploy to production → Follow Production Deployment Guide
Implement high availability → See HA Stateless Containers and Quick Start: HA
Build a SaaS application → Check Multi-Tenant Architectures
Troubleshoot issues → Visit Troubleshooting Guide
Optimize performance → Read Performance Tuning
📖 Reading Order
For Beginners
For Application Developers
- Container Development Guide
- Agent Development Guide
- Multi-Tenant Architectures
- Error Handling Best Practices
For DevOps Engineers
- Installation Guide
- Network Server Setup
- Production Deployment Guide
- Monitoring and Observability
- Security Best Practices
For System Architects
🔗 External Resources
🤝 Contributing to Documentation
We welcome contributions to improve our documentation! Please:
- Check existing docs to avoid duplication
- Follow the same structure and formatting
- Include code examples where appropriate
- Test all code examples before submitting
- 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
- Review the Examples
- Open an issue on GitHub
- Join our community discussions
Last updated: October 2025