📚 Orbit Framework Documentation

Welcome to the official documentation for the Orbit UI Framework - a Rust-first, cross-platform UI framework for building Web, Native, and Embedded applications.

🧭 Documentation Structure

• Getting Started

  • Installation and setup
  • Building your first Orbit application (Video Guide)
  • Development workflow
  • Project Structure
  • Project Templates Visual Guide

• Core Concepts

  • Component Model
  • Advanced Component Patterns
  • .orbit File Format
  • Rendering Architecture
  • State Management
  • Event Handling

• Guides

  • Performance Optimization
  • Accessibility
  • Deployment Guide
  • Testing Strategies
  • Debugging Guide
  • Cross-platform development

• API Reference

  • API Documentation Template
  • orbit core API
  • orbitkit components
  • orbiton CLI
  • Project Templates Visual Guide
  • orlint

• Examples

  • Sample applications
  • Component patterns
  • Integration examples
  • Video Tutorials

• Roadmap

  • Documentation Improvement Plan
  • Development plan
  • Milestones
  • Feature timeline
  • Long-term vision

• Progress Reports

  • Development Efficiency Report
  • Commit-Based Progress Report
  • Development Dashboard

• Contributing

  • How to contribute
  • Development setup
  • Code guidelines

📅 Documentation Updates

This documentation is continuously updated as the framework evolves. Each release includes corresponding documentation updates to reflect new features, improvements, and best practices.

Recent Updates (May 2025)

• Video Tutorials: Added complete Task Manager Tutorial Video Guide with timestamped sections and interactive code examples
• Enhanced CLI Documentation: Created comprehensive Visual Guide to Project Templates for orbiton new command
• Documentation Completion: All items in the Content Gap Analysis are now marked as completed
• Examples Reorganization: The examples project has been restructured to fix build target conflicts and provide clearer demonstrations of framework features
• Component Model Progress: Added comprehensive examples showing props system, component lifecycle and event handling
• Rendering Engines: Added examples for both Skia-based 2D and WGPU-based 3D rendering
• Project Milestones: Updated Milestone 1 Tracking with latest progress

For a complete overview of recent changes, see the May 2025 Progress Report and the Documentation Progress Report.

🔄 Work in Progress

The Orbit Framework is under active development. All planned documentation sections have been completed as of May 2025, and new documentation will be created as additional features are implemented.

📹 Video Content

We now provide video tutorials to complement our written documentation:

• Task Manager Tutorial Video Series - A comprehensive video walkthrough of building a task manager application
• Additional video series on advanced topics coming soon

🤝 Contributing to Documentation

We welcome contributions to our documentation! If you find issues, have suggestions for improvements, or want to add examples, please submit a pull request or open an issue on our GitHub repository.

📞 Getting Help

If you need assistance beyond what's covered in the documentation:

• Join our GitHub Discussions
• Check out the FAQ section
• Reach out on our community Discord (coming soon)

Thank you for being part of the Orbit community!