Comprehensive documentation for TFGrid Studio - Complete development platform for ThreeFold Grid

This repository contains complete documentation for the TFGrid Studio platform.

• Introduction - What is TFGrid Studio
• Installation - Install and configure
• Quick Start - Deploy in 5 minutes
• Core Concepts - Patterns, apps, manifests (coming soon)

• Pattern Overview - Understanding patterns ✅
• Single-VM Pattern - ✅ Production ready
• Gateway Pattern - ✅ Production ready (v2.0.0)
• K3s Pattern - ✅ Production ready (v2.0.0)

• Application Overview - How apps work (coming soon)
• TFGrid AI Agent - ✅ AI coding agent (coming soon)
• Creating Apps - Build deployable apps (coming soon)

• CLI Commands - Complete command reference (coming soon)
• App Manifest - tfgrid-compose.yaml spec (coming soon)
• Context File - .tfgrid-compose.yaml usage (coming soon)
• State Management - State tracking (coming soon)

• Migration Guide - From standalone repos (coming soon)
• Advanced Deployment - Production strategies (coming soon)
• Networking - WireGuard, Mycelium (coming soon)
• Security - Best practices (coming soon)
• Troubleshooting - Common issues (coming soon)

• System Architecture - How it works (coming soon)
• Platform Map - High-level view of repos & products
• Design Decisions - Why we built this way (coming soon)
• Source Repositories - ✅ Acknowledgment & credits
• Comparison - vs alternatives (coming soon)

• Current Status - ✅ v2.0.0 Complete First Layer
• Planned Features - Testing & web dashboard
• Changelog - Version history (coming soon)

• Overview - How to contribute (coming soon)
• Development - Dev setup (coming soon)

1. What is TFGrid Compose?
2. Install
3. Deploy your first app

1. Core concepts (coming soon)
2. Creating apps (coming soon)
3. Contributing (coming soon)

• What's Working Now - v2.0.0 Complete First Layer ✅
• What's Coming Next - Testing & polish
• Source Acknowledgment - Built from proven code

Overall Progress: ~35% complete (all patterns documented)

• ✅ Main landing page (index.md)
• ✅ Introduction guide
• ✅ Installation guide
• ✅ Quick start guide
• ✅ Current status documentation (v2.0.0)
• ✅ Planned features roadmap
• ✅ Source repository acknowledgment
• ✅ All 3 pattern documentation (single-vm, gateway, k3s)

• Application guides
• CLI reference
• Architecture docs
• Migration guides

• Complete all guide sections
• Add diagrams and visuals
• Create video tutorials
• Interactive examples

The documentation is hosted at https://docs.tfgrid.studio using MkDocs Material.

• Beautiful, searchable, mobile-friendly interface
• Dark mode support
• Version switching (planned)

Use MkDocs Material to build and preview the site locally:

# Install MkDocs Material
pip install mkdocs-material

# Serve locally
mkdocs serve

# Build static site
mkdocs build

Documentation contributions are welcome!

1. Fork this repository
2. Create a new branch for your changes
3. Edit or add Markdown files
4. Submit a pull request

• ✅ Use clear, concise language
• ✅ Include code examples
• ✅ Add status indicators (✅, 🚧, 📋)
• ✅ Link related docs
• ✅ Keep consistent formatting

Apache 2.0 License - See LICENSE file for details.

• tfgrid-compose - Main CLI tool
• tfgrid-ai-agent - AI coding agent
• TFGrid Studio - All repositories