{"id":35066608,"url":"https://github.com/tfgrid-studio/tfgrid-docs","last_synced_at":"2026-05-23T05:32:36.370Z","repository":{"id":318766599,"uuid":"1072481150","full_name":"tfgrid-studio/tfgrid-docs","owner":"tfgrid-studio","description":"Documentation for TFGrid Studio - docs.tfgrid.studio","archived":false,"fork":false,"pushed_at":"2025-12-17T05:55:16.000Z","size":5190,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-18T19:55:22.647Z","etag":null,"topics":["decentralized","docs","documentation","mkdocs","tfgrid-studio","threefold"],"latest_commit_sha":null,"homepage":"https://docs.tfgrid.studio","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tfgrid-studio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":"docs/roadmap/index.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-08T19:24:29.000Z","updated_at":"2025-12-17T05:54:53.000Z","dependencies_parsed_at":"2025-12-03T22:02:38.814Z","dependency_job_id":null,"html_url":"https://github.com/tfgrid-studio/tfgrid-docs","commit_stats":null,"previous_names":["tfgrid-studio/tfgrid-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tfgrid-studio/tfgrid-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tfgrid-studio%2Ftfgrid-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tfgrid-studio%2Ftfgrid-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tfgrid-studio%2Ftfgrid-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tfgrid-studio%2Ftfgrid-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tfgrid-studio","download_url":"https://codeload.github.com/tfgrid-studio/tfgrid-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tfgrid-studio%2Ftfgrid-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28078024,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-27T02:00:05.897Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["decentralized","docs","documentation","mkdocs","tfgrid-studio","threefold"],"created_at":"2025-12-27T11:30:58.810Z","updated_at":"2025-12-27T11:31:00.606Z","avatar_url":"https://github.com/tfgrid-studio.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TFGrid Studio Documentation\n\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)\n[![Docs](https://img.shields.io/badge/docs-docs.tfgrid.studio-blue)](https://docs.tfgrid.studio)\n[![GitHub stars](https://img.shields.io/github/stars/tfgrid-studio/tfgrid-docs)](https://github.com/tfgrid-studio/tfgrid-docs/stargazers)\n\n**Comprehensive documentation for TFGrid Studio - Complete development platform for ThreeFold Grid**\n\n---\n\n## 📖 Documentation Structure\n\nThis repository contains complete documentation for the TFGrid Studio platform.\n\n### Getting Started\n\n- **[Introduction](getting-started/introduction.md)** - What is TFGrid Studio\n- **[Installation](getting-started/installation.md)** - Install and configure\n- **[Quick Start](getting-started/quickstart.md)** - Deploy in 5 minutes\n- **[Core Concepts](getting-started/concepts.md)** - Patterns, apps, manifests _(coming soon)_\n\n### Deployment Patterns\n\n- **[Pattern Overview](patterns/overview.md)** - Understanding patterns ✅\n- **[Single-VM Pattern](patterns/single-vm/)** - ✅ Production ready\n- **[Gateway Pattern](patterns/gateway/)** - ✅ Production ready (v2.0.0)\n- **[K3s Pattern](patterns/k3s/)** - ✅ Production ready (v2.0.0)\n\n### Applications\n\n- **[Application Overview](applications/overview.md)** - How apps work _(coming soon)_\n- **[TFGrid AI Agent](applications/tfgrid-ai-agent/)** - ✅ AI coding agent _(coming soon)_\n- **[Creating Apps](applications/creating-apps.md)** - Build deployable apps _(coming soon)_\n\n### CLI Reference\n\n- **[CLI Commands](reference/cli.md)** - Complete command reference _(coming soon)_\n- **[App Manifest](reference/manifest.md)** - `tfgrid-compose.yaml` spec _(coming soon)_\n- **[Context File](reference/context-file.md)** - `.tfgrid-compose.yaml` usage _(coming soon)_\n- **[State Management](reference/state.md)** - State tracking _(coming soon)_\n\n### Guides\n\n- **[Migration Guide](guides/migration.md)** - From standalone repos _(coming soon)_\n- **[Advanced Deployment](guides/deployment.md)** - Production strategies _(coming soon)_\n- **[Networking](guides/networking.md)** - WireGuard, Mycelium _(coming soon)_\n- **[Security](guides/security.md)** - Best practices _(coming soon)_\n- **[Troubleshooting](guides/troubleshooting.md)** - Common issues _(coming soon)_\n\n### Architecture\n\n- **[System Architecture](architecture/overview.md)** - How it works _(coming soon)_\n- **[Platform Map](architecture/platform-map.md)** - High-level view of repos \u0026 products\n- **[Design Decisions](architecture/design-decisions.md)** - Why we built this way _(coming soon)_\n- **[Source Repositories](architecture/source-repos.md)** - ✅ Acknowledgment \u0026 credits\n- **[Comparison](architecture/comparison.md)** - vs alternatives _(coming soon)_\n\n### Roadmap\n\n- **[Current Status](roadmap/current.md)** - ✅ v2.0.0 Complete First Layer\n- **[Planned Features](roadmap/planned.md)** - Testing \u0026 web dashboard\n- **[Changelog](roadmap/changelog.md)** - Version history _(coming soon)_\n\n### Contributing\n\n- **[Overview](contributing/overview.md)** - How to contribute _(coming soon)_\n- **[Development](contributing/development.md)** - Dev setup _(coming soon)_\n\n---\n\n## 🚀 Quick Links\n\n### For New Users\n1. [What is TFGrid Compose?](getting-started/introduction.md)\n2. [Install](getting-started/installation.md)\n3. [Deploy your first app](getting-started/quickstart.md)\n\n### For Developers\n1. [Core concepts](getting-started/concepts.md) _(coming soon)_\n2. [Creating apps](applications/creating-apps.md) _(coming soon)_\n3. [Contributing](contributing/overview.md) _(coming soon)_\n\n### Current Status\n\n- **[What's Working Now](roadmap/current.md)** - v2.0.0 Complete First Layer ✅\n- **[What's Coming Next](roadmap/planned.md)** - Testing \u0026 polish\n- **[Source Acknowledgment](architecture/source-repos.md)** - Built from proven code\n\n---\n\n## 📊 Documentation Status\n\n| Section | Files Created | Status |\n|---------|---------------|--------|\n| **Main Index** | 1/1 | ✅ Complete |\n| **Getting Started** | 3/4 | 🔄 75% |\n| **Patterns** | 3/4 | ✅ 75% (All 3 patterns documented) |\n| **Applications** | 0/3 | 📋 Planned |\n| **Reference** | 0/5 | 📋 Planned |\n| **Guides** | 0/5 | 📋 Planned |\n| **Architecture** | 1/4 | 🔄 25% |\n| **Roadmap** | 2/3 | ✅ 67% (Updated to v2.0.0) |\n| **Contributing** | 0/2 | 📋 Planned |\n\n**Overall Progress:** ~35% complete (all patterns documented)\n\n---\n\n## 🎯 Current Focus\n\n### ✅ Completed (Phase 1-2)\n\n- ✅ Main landing page (`index.md`)\n- ✅ Introduction guide\n- ✅ Installation guide\n- ✅ Quick start guide\n- ✅ Current status documentation (v2.0.0)\n- ✅ Planned features roadmap\n- ✅ Source repository acknowledgment\n- ✅ All 3 pattern documentation (single-vm, gateway, k3s)\n\n### 🚧 In Progress (Phase 3)\n\n- [ ] Application guides\n- [ ] CLI reference\n- [ ] Architecture docs\n- [ ] Migration guides\n\n### 📋 Planned (Phase 3)\n- [ ] Complete all guide sections\n- [ ] Add diagrams and visuals\n- [ ] Create video tutorials\n- [ ] Interactive examples\n\n---\n\n## 🌐 Live Documentation Site\n\nThe documentation is hosted at **https://docs.tfgrid.studio** using **MkDocs Material**.\n\n- Beautiful, searchable, mobile-friendly interface\n- Dark mode support\n- Version switching (planned)\n\n---\n\n## 🛠️ Building Locally\n\nUse MkDocs Material to build and preview the site locally:\n\n```bash\n# Install MkDocs Material\npip install mkdocs-material\n\n# Serve locally\nmkdocs serve\n\n# Build static site\nmkdocs build\n```\n\n---\n\n## 🤝 Contributing to Docs\n\nDocumentation contributions are welcome!\n\n### How to Contribute\n1. Fork this repository\n2. Create a new branch for your changes\n3. Edit or add Markdown files\n4. Submit a pull request\n\n### Documentation Standards\n- ✅ Use clear, concise language\n- ✅ Include code examples\n- ✅ Add status indicators (✅, 🚧, 📋)\n- ✅ Link related docs\n- ✅ Keep consistent formatting\n\n---\n\n## 📝 License\n\nApache 2.0 License - See [LICENSE](LICENSE) file for details.\n\n---\n\n## 🔗 Related Repositories\n\n- **[tfgrid-compose](https://github.com/tfgrid-studio/tfgrid-compose)** - Main CLI tool\n- **[tfgrid-ai-agent](https://github.com/tfgrid-studio/tfgrid-ai-agent)** - AI coding agent\n- **[TFGrid Studio](https://github.com/tfgrid-studio)** - All repositories","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftfgrid-studio%2Ftfgrid-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftfgrid-studio%2Ftfgrid-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftfgrid-studio%2Ftfgrid-docs/lists"}