mirror of
https://github.com/hcengineering/platform.git
synced 2026-08-21 11:52:23 +02:00
Denis Bykhov
da88233dda
git-subtree-dir: foundations/net git-subtree-mainline:2b0d510202git-subtree-split:7722c95341
3.2 KiB
3.2 KiB
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
- Core Concepts - Understanding the architecture
Guides
- Container Development Guide - Building containers and implementing services
- Auto-Disposal Guide - Managing container lifecycle and cleanup
Advanced Topics
- High Availability (HA) Stateless Containers - Automatic failover
- Quick Start: HA - HA setup in 5 minutes
- Multi-Tenant Architectures - Building SaaS applications
Production
- Production Deployment Guide - Going to production
🎯 Quick Navigation
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
📖 Reading Order
For Beginners
For Application Developers
For DevOps Engineers
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