Add comprehensive architecture and layout documentation#111
Merged
thomasnemer merged 1 commit intomainfrom Nov 11, 2025
Merged
Conversation
This commit adds three comprehensive technical documentation files to help developers understand and use the Prong UI framework effectively: 1. docs/architecture.md (25KB) - Framework architecture overview with system diagrams - Scene-based system design and component hierarchy - CRTP pattern usage and benefits - Coordinate system overview with caching details - Renderer abstraction and interface - Hierarchical event system with propagation flow - Focus management and platform abstractions - Build system integration and C++20 features 2. docs/layouts.md (31KB) - Comprehensive guide to all 5 layout managers - FlexLayout (flexbox-inspired), GridLayout, DockLayout, StackLayout, FlowLayout - Detailed configuration options and properties - Visual ASCII diagrams for each layout type - Real-world use cases and nested layout examples - Layout performance tips and troubleshooting 3. docs/best_practices.md (27KB) - Scene organization patterns - Layout selection decision tree - Component creation with ComponentBuilder - Coordinate system best practices - Event handling patterns and callbacks - Resize behavior guidelines for responsive UIs - Performance optimization tips - Common pitfalls and testing practices All documentation includes: - Practical code examples reflecting current API - Cross-references to existing docs (coordinate_system.md, component_builder.md) - Clear structure with logical sections - Visual aids and diagrams - Good/bad example comparisons Content extracted and adapted from CLAUDE.md for general developer consumption. Closes #14
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds three comprehensive technical documentation files to help developers understand and use the Prong UI framework effectively.
Documentation Added
1. docs/architecture.md (25KB, 756 lines)
Framework architecture guide covering:
2. docs/layouts.md (31KB, 1,195 lines)
Comprehensive layout system guide including:
3. docs/best_practices.md (27KB, 1,124 lines)
Practical guidelines covering:
Key Features
✅ Comprehensive coverage of all major framework concepts
✅ Practical code examples throughout (verified against current API)
✅ Cross-references to existing docs (coordinate_system.md, component_builder.md)
✅ Visual aids (ASCII diagrams, flow charts, layout examples)
✅ Good/bad example comparisons
✅ Developer-focused (adapted from CLAUDE.md)
Checklist
Test Plan
Documentation can be reviewed for:
Closes #14