https://github.com/tfgrid-studio/tfgrid-docs
Documentation for TFGrid Studio - docs.tfgrid.studio
https://github.com/tfgrid-studio/tfgrid-docs
decentralized docs documentation mkdocs tfgrid-studio threefold
Last synced: 12 days ago
JSON representation
Documentation for TFGrid Studio - docs.tfgrid.studio
- Host: GitHub
- URL: https://github.com/tfgrid-studio/tfgrid-docs
- Owner: tfgrid-studio
- License: apache-2.0
- Created: 2025-10-08T19:24:29.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-12-17T05:55:16.000Z (6 months ago)
- Last Synced: 2025-12-18T19:55:22.647Z (6 months ago)
- Topics: decentralized, docs, documentation, mkdocs, tfgrid-studio, threefold
- Language: HTML
- Homepage: https://docs.tfgrid.studio
- Size: 4.95 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
- Roadmap: docs/roadmap/index.md
Awesome Lists containing this project
README
# TFGrid Studio Documentation
[](LICENSE)
[](https://docs.tfgrid.studio)
[](https://github.com/tfgrid-studio/tfgrid-docs/stargazers)
**Comprehensive documentation for TFGrid Studio - Complete development platform for ThreeFold Grid**
---
## 📖 Documentation Structure
This repository contains complete documentation for the TFGrid Studio platform.
### Getting Started
- **[Introduction](getting-started/introduction.md)** - What is TFGrid Studio
- **[Installation](getting-started/installation.md)** - Install and configure
- **[Quick Start](getting-started/quickstart.md)** - Deploy in 5 minutes
- **[Core Concepts](getting-started/concepts.md)** - Patterns, apps, manifests _(coming soon)_
### Deployment Patterns
- **[Pattern Overview](patterns/overview.md)** - Understanding patterns ✅
- **[Single-VM Pattern](patterns/single-vm/)** - ✅ Production ready
- **[Gateway Pattern](patterns/gateway/)** - ✅ Production ready (v2.0.0)
- **[K3s Pattern](patterns/k3s/)** - ✅ Production ready (v2.0.0)
### Applications
- **[Application Overview](applications/overview.md)** - How apps work _(coming soon)_
- **[TFGrid AI Agent](applications/tfgrid-ai-agent/)** - ✅ AI coding agent _(coming soon)_
- **[Creating Apps](applications/creating-apps.md)** - Build deployable apps _(coming soon)_
### CLI Reference
- **[CLI Commands](reference/cli.md)** - Complete command reference _(coming soon)_
- **[App Manifest](reference/manifest.md)** - `tfgrid-compose.yaml` spec _(coming soon)_
- **[Context File](reference/context-file.md)** - `.tfgrid-compose.yaml` usage _(coming soon)_
- **[State Management](reference/state.md)** - State tracking _(coming soon)_
### Guides
- **[Migration Guide](guides/migration.md)** - From standalone repos _(coming soon)_
- **[Advanced Deployment](guides/deployment.md)** - Production strategies _(coming soon)_
- **[Networking](guides/networking.md)** - WireGuard, Mycelium _(coming soon)_
- **[Security](guides/security.md)** - Best practices _(coming soon)_
- **[Troubleshooting](guides/troubleshooting.md)** - Common issues _(coming soon)_
### Architecture
- **[System Architecture](architecture/overview.md)** - How it works _(coming soon)_
- **[Platform Map](architecture/platform-map.md)** - High-level view of repos & products
- **[Design Decisions](architecture/design-decisions.md)** - Why we built this way _(coming soon)_
- **[Source Repositories](architecture/source-repos.md)** - ✅ Acknowledgment & credits
- **[Comparison](architecture/comparison.md)** - vs alternatives _(coming soon)_
### Roadmap
- **[Current Status](roadmap/current.md)** - ✅ v2.0.0 Complete First Layer
- **[Planned Features](roadmap/planned.md)** - Testing & web dashboard
- **[Changelog](roadmap/changelog.md)** - Version history _(coming soon)_
### Contributing
- **[Overview](contributing/overview.md)** - How to contribute _(coming soon)_
- **[Development](contributing/development.md)** - Dev setup _(coming soon)_
---
## 🚀 Quick Links
### For New Users
1. [What is TFGrid Compose?](getting-started/introduction.md)
2. [Install](getting-started/installation.md)
3. [Deploy your first app](getting-started/quickstart.md)
### For Developers
1. [Core concepts](getting-started/concepts.md) _(coming soon)_
2. [Creating apps](applications/creating-apps.md) _(coming soon)_
3. [Contributing](contributing/overview.md) _(coming soon)_
### Current Status
- **[What's Working Now](roadmap/current.md)** - v2.0.0 Complete First Layer ✅
- **[What's Coming Next](roadmap/planned.md)** - Testing & polish
- **[Source Acknowledgment](architecture/source-repos.md)** - Built from proven code
---
## 📊 Documentation Status
| Section | Files Created | Status |
|---------|---------------|--------|
| **Main Index** | 1/1 | ✅ Complete |
| **Getting Started** | 3/4 | 🔄 75% |
| **Patterns** | 3/4 | ✅ 75% (All 3 patterns documented) |
| **Applications** | 0/3 | 📋 Planned |
| **Reference** | 0/5 | 📋 Planned |
| **Guides** | 0/5 | 📋 Planned |
| **Architecture** | 1/4 | 🔄 25% |
| **Roadmap** | 2/3 | ✅ 67% (Updated to v2.0.0) |
| **Contributing** | 0/2 | 📋 Planned |
**Overall Progress:** ~35% complete (all patterns documented)
---
## 🎯 Current Focus
### ✅ Completed (Phase 1-2)
- ✅ 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)
### 🚧 In Progress (Phase 3)
- [ ] Application guides
- [ ] CLI reference
- [ ] Architecture docs
- [ ] Migration guides
### 📋 Planned (Phase 3)
- [ ] Complete all guide sections
- [ ] Add diagrams and visuals
- [ ] Create video tutorials
- [ ] Interactive examples
---
## 🌐 Live Documentation Site
The documentation is hosted at **https://docs.tfgrid.studio** using **MkDocs Material**.
- Beautiful, searchable, mobile-friendly interface
- Dark mode support
- Version switching (planned)
---
## 🛠️ Building Locally
Use MkDocs Material to build and preview the site locally:
```bash
# Install MkDocs Material
pip install mkdocs-material
# Serve locally
mkdocs serve
# Build static site
mkdocs build
```
---
## 🤝 Contributing to Docs
Documentation contributions are welcome!
### How to Contribute
1. Fork this repository
2. Create a new branch for your changes
3. Edit or add Markdown files
4. Submit a pull request
### Documentation Standards
- ✅ Use clear, concise language
- ✅ Include code examples
- ✅ Add status indicators (✅, 🚧, 📋)
- ✅ Link related docs
- ✅ Keep consistent formatting
---
## 📝 License
Apache 2.0 License - See [LICENSE](LICENSE) file for details.
---
## 🔗 Related Repositories
- **[tfgrid-compose](https://github.com/tfgrid-studio/tfgrid-compose)** - Main CLI tool
- **[tfgrid-ai-agent](https://github.com/tfgrid-studio/tfgrid-ai-agent)** - AI coding agent
- **[TFGrid Studio](https://github.com/tfgrid-studio)** - All repositories