docs

GoFlow Documentation

Welcome to the complete GoFlow documentation! This guide will help you navigate all available resources.

📚 Documentation Index

Getting Started

• Getting Started Guide - Complete beginner tutorial from installation to first app
• CLI Documentation - Complete CLI reference for goflow command
• Project Structure - Understanding GoFlow project layout

Core Concepts

• Architecture - Framework architecture (widgets, elements, render objects)
• Rendering Architecture - How rendering works (native backends vs WGPU)
• Flutter Inspiration - Comparison with Flutter and migration guide
• Design Systems - Material, Cupertino, and Adaptive widgets

Widget Documentation

• Widget Reference - Complete catalog of all 27+ widgets
• Layout Completion Summary - Layout system implementation details
• Widget Examples - Detailed widget documentation by category

Developer Experience

• Hot Reload - Hot reload system with state preservation
• Testing Framework - Widget testing, golden tests, and integration testing
• Navigation - GetX-style navigation and routing
• Input System - Mouse, keyboard, and gesture handling

Advanced Topics

• Platform Integration - Native platform projects roadmap (Xcode, CMake, VS)
• Development Status - Current development branch status
• Progress Tracking - Detailed progress and roadmap
• Workflow Guide - Complete technical workflow

Examples

• Playground Example - Comprehensive framework feature test
• More Examples - Additional example applications

🚀 Quick Navigation

I want to...

...get started with GoFlow

→ Start with Getting Started Guide

...understand how GoFlow works internally

→ Read Architecture

...create a new project

→ See CLI Documentation

...understand the project structure

→ Read Project Structure

...know how rendering works

→ Read Rendering Architecture

...see all available widgets

→ Browse Widget Reference

...implement hot reload in my app

→ Check Hot Reload Guide

...write tests for my widgets

→ See Testing Framework

...add navigation to my app

→ Read Navigation Guide

...migrate from Flutter

→ See Flutter Inspiration

...contribute to GoFlow

→ Check Progress Tracking for roadmap

📖 Documentation by Topic

Installation & Setup

1. Installing the CLI
2. Creating your first project
3. Setting up dependencies
4. Running your app

Core Framework

1. Widgets - UI building blocks
2. Elements - Lifecycle management
3. RenderObjects - Layout & painting
4. The Three Trees
5. Layout System
6. Widget Reference - All available widgets

State Management

1. Signals - Reactive values
2. Computed Signals
3. Signal Collections
4. Effects - Side effects
5. Batch Updates

Widgets & UI

1. Built-in Widgets
2. Text Widget
3. Container Widget
4. Layout Widgets
5. Building Custom Widgets

Rendering & Platform

1. Rendering Overview
2. Canvas Interface
3. Native Backends
4. WGPU Backend
5. Platform Integration Roadmap

CLI & Tools

1. CLI Commands
2. goflow create
3. Project Templates
4. Platform Selection
5. Hot Reload
6. Testing Framework
7. Troubleshooting

🎯 Learning Paths

Path 1: Complete Beginner

1. Read Getting Started
2. Run the Playground Example
3. Create your own app using goflow create
4. Read Architecture when ready for details

Path 2: Flutter Developer

1. Read Flutter Inspiration for comparison
2. Skim Getting Started focusing on differences
3. Review Signals (replaces setState)
4. Start building!

Path 3: Framework Contributor

1. Read Architecture thoroughly
2. Read Rendering Architecture
3. Review Progress Tracking for roadmap
4. Check Development Status for current state
5. Review Platform Integration roadmap
6. Check out the codebase structure
7. Look for contribution opportunities

📝 Document Status

Document	Status	Version
Getting Started	✅ Complete	v0.2.0
CLI Documentation	✅ Complete	v0.2.0
Project Structure	✅ Complete	v0.2.0
Architecture	✅ Complete	v0.2.0
Rendering	✅ Complete	v0.2.0
Flutter Inspiration	✅ Complete	v0.2.0
Design Systems	✅ Complete	v0.2.0
Widget Reference	✅ Complete	v0.2.0
Layout Summary	✅ Complete	v0.2.0
Hot Reload	✅ Complete	v0.2.0
Testing Framework	✅ Complete	v0.2.0
Navigation	✅ Complete	v0.2.0
Input System	✅ Complete	v0.2.0
Progress Tracking	✅ Complete	v0.2.0
Development Status	✅ Complete	v0.2.0
Workflow Guide	✅ Complete	v0.2.0
Platform Integration	✅ Roadmap	v0.2.0

🔗 External Resources

Go Resources

• Go Documentation
• Go by Example
• Effective Go

Framework Inspiration

• Flutter Architecture
• Preact Signals
• Solid.js Reactivity

Rendering & Graphics

• Core Graphics (macOS)
• Direct2D (Windows)
• Cairo (Linux)
• WebGPU

💡 Tips for Reading

• Beginner? Start with Getting Started and follow along
• Skimming? Each doc has a table of contents
• Looking for something specific? Use the "I want to..." section above
• Want details? Architecture and Rendering docs are comprehensive
• Need examples? Check the examples directory

🆘 Getting Help

Can't find what you're looking for?

1. Check the FAQ
2. Search through all docs (Cmd/Ctrl+F across files)
3. Look at example code
4. Ask in GitHub Discussions
5. Report missing documentation

🎨 Contributing to Docs

Found an error? Have a suggestion? Want to improve the docs?

• Docs are written in Markdown
• Located in /docs directory
• Follow existing structure and style
• Add examples where helpful
• Keep explanations clear and concise

📅 What's Next?

Upcoming documentation:

• Animation System Guide (when implemented)
• Performance Optimization Guide
• Publishing & Distribution Guide
• Advanced Gesture Handling
• Custom Render Objects Guide
• Plugin Development Guide

---

Happy learning! 🚀