Skip to content

Latest commit

 

History

History
155 lines (123 loc) · 4.83 KB

README.md

File metadata and controls

155 lines (123 loc) · 4.83 KB

Mycelium Cloud Documentation

Welcome to the Mycelium Cloud documentation! This directory contains comprehensive guides and references for using, deploying, and contributing to the project.

Documentation Structure

Getting Started

  • Getting Started Guide - Quick setup and running locally
    • Prerequisites and installation
    • Local development setup
    • Docker Compose quick start
    • Mycelium networking setup

Core Documentation

Architecture

  • Architecture Overview - System design and components
    • System architecture diagram
    • Component descriptions
    • Data flow
    • Technology stack

API

  • API Documentation - REST API reference
    • Endpoints and resources
    • Authentication
    • Request/response formats
    • Error codes
    • Rate limiting
    • Examples and SDKs

Deployment

  • Deployment Guide - Production deployment
    • Local development
    • Docker Compose
    • Kubernetes deployment
    • TFGrid deployment
    • Environment configuration

Contributing

  • Contributing Guide - How to contribute
    • Code of conduct
    • Development setup
    • Code style guidelines
    • Testing requirements
    • Pull request process
    • Areas for contribution

Development Guides

  • Backend README - Go API server

    • Configuration options
    • API endpoints
    • Database setup
    • Running tests

  • Frontend README - Vue.js application

    • Development environment
    • Building and testing
    • Component structure
    • Configuration

  • CRD Documentation - Kubernetes Custom Resources

    • CRD definitions
    • Controller setup
    • Usage examples

  • Mycelium CNI - P2P networking

    • Installation
    • Configuration
    • Troubleshooting

Quick Navigation

Need Go To
Set up locally Getting Started
Understand architecture Architecture Overview
Use the API API Documentation
Deploy to production Deployment Guide
Contribute code Contributing Guide
Configure backend Backend README
Build frontend Frontend README

By Role

For Users

  1. Start with Getting Started
  2. Read Architecture Overview to understand the system
  3. Check API Documentation for integrations

For Developers

  1. Clone and follow Getting Started
  2. Read Contributing Guide
  3. Explore component READMEs:
  4. Check Architecture for system design

For DevOps/Deployment

  1. Review Deployment Guide
  2. Check component-specific docs:

For Contributors

  1. Read Contributing Guide
  2. Follow Getting Started for setup
  3. Check Code Style Guidelines
  4. Review Pull Request Process

Additional Resources

Component Documentation

  • Backend: backend/README.md
  • Frontend: frontend/kubecloud/README.md
  • CRD: crd/README.md
  • Ingress Controller: ingress-controller/README.md
  • Mycelium CNI: mycelium-cni/README.md
  • K3s: k3s/README.md

External Links

Documentation Standards

All documentation in this project follows these standards:

  • Clear, concise language
  • Practical examples
  • Proper formatting and structure
  • Links to related docs
  • Keep it up-to-date
  • Include troubleshooting tips

Contributing Documentation

Documentation contributions are welcome! See Contributing Guide for details.

To contribute docs:

  1. Fork the repository
  2. Create a branch for your changes
  3. Follow the Documentation Standards
  4. Submit a pull request

Last Updated: 2025-11-16

For the latest information, visit the GitHub Repository.