mirror of
https://github.com/hcengineering/platform.git
synced 2026-08-21 03:42:24 +02:00
Denis Bykhov
da88233dda
git-subtree-dir: foundations/net git-subtree-mainline:2b0d510202git-subtree-split:7722c95341
106 lines
3.2 KiB
Markdown
106 lines
3.2 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
|
|
- **[Core Concepts](CORE_CONCEPTS.md)** - Understanding the architecture
|
|
|
|
### Guides
|
|
|
|
- **[Container Development Guide](CONTAINER_DEVELOPMENT.md)** - Building containers and implementing services
|
|
- **[Auto-Disposal Guide](AUTO_DISPOSAL_GUIDE.md)** - Managing container lifecycle and cleanup
|
|
|
|
### Advanced Topics
|
|
|
|
- **[High Availability (HA) Stateless Containers](HA_STATELESS_CONTAINERS.md)** - Automatic failover
|
|
- **[Quick Start: HA](QUICKSTART_HA.md)** - HA setup in 5 minutes
|
|
- **[Multi-Tenant Architectures](MULTI_TENANT.md)** - Building SaaS applications
|
|
|
|
### Production
|
|
|
|
- **[Production Deployment Guide](PRODUCTION_DEPLOYMENT.md)** - Going to production
|
|
|
|
## 🎯 Quick Navigation
|
|
|
|
**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)
|
|
|
|
## 📖 Reading Order
|
|
|
|
### For Beginners
|
|
|
|
1. [Quick Start Guide](QUICKSTART.md)
|
|
2. [Core Concepts](CORE_CONCEPTS.md)
|
|
3. [Container Development Guide](CONTAINER_DEVELOPMENT.md)
|
|
|
|
### For Application Developers
|
|
|
|
1. [Container Development Guide](CONTAINER_DEVELOPMENT.md)
|
|
2. [Multi-Tenant Architectures](MULTI_TENANT.md)
|
|
3. [Auto-Disposal Guide](AUTO_DISPOSAL_GUIDE.md)
|
|
|
|
### For DevOps Engineers
|
|
|
|
1. [Production Deployment Guide](PRODUCTION_DEPLOYMENT.md)
|
|
2. [High Availability](HA_STATELESS_CONTAINERS.md)
|
|
|
|
### For System Architects
|
|
|
|
1. [Core Concepts](CORE_CONCEPTS.md)
|
|
2. [High Availability](HA_STATELESS_CONTAINERS.md)
|
|
3. [Production Deployment Guide](PRODUCTION_DEPLOYMENT.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
|