docs: Improve CoreConcepts.md structure with '5 Core Principles'#20
Merged
takeshishimada merged 1 commit intomainfrom Oct 31, 2025
Merged
Conversation
Restructured the Core Concepts documentation to better communicate Flow's design philosophy: - Organized content into "The 5 Core Principles" with clear numbering - Added "View-Local State: Aligned with SwiftUI Philosophy" section explaining why Flow avoids global stores and store hierarchies - Enhanced "MainActor Isolation" section with better benefits: - Code locality - all related code in one place - Intuitive - write naturally like regular Swift - Compile-time safety - data races caught at compile time - No manual dispatch needed - Moved "Observable Actions" (middleware) to "Additional Features" as it's not a core principle - Removed separator lines (---) to match other documentation format - Added clearer "Benefits" sections for each principle - Improved explanations of why each principle matters This structure is inspired by the Medium article's clear communication of Flow's design philosophy. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
takeshishimada
added a commit
that referenced
this pull request
Oct 31, 2025
Updated both README.md and README_jp.md to match the "5 Core Principles" structure from MEDIUM_ARTICLE_EN.md: 1. Unidirectional Data Flow (newly added) - Explains the fundamental flow: Action → Handler → State → View - Emphasizes predictability and debuggability 2. View-Local State (evolved from "No Global Store") - Emphasizes alignment with SwiftUI's philosophy - Highlights no global stores or store hierarchies 3. Result-Returning Actions (simplified) - More concise code examples - Clear benefits: functional patterns, parent controls side effects 4. MainActor Isolation (evolved from "Swift 6 Concurrency") - Emphasizes direct state updates in async context - Benefits: code locality, intuitive, compile-time safety 5. @observable Support (simplified) - Kept concise with essential benefits Removed: - "Observable Actions" section (middleware is not a core principle) Users can discover middleware through documentation This creates consistency across: - README.md / README_jp.md - CoreConcepts.md (already updated in PR #20) - MEDIUM_ARTICLE_EN.md / MEDIUM_ARTICLE_JP.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
4 tasks
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
Key Improvements
Structure
New Content
✅ Principle 2: View-Local State: Aligned with SwiftUI Philosophy
✅ Enhanced Principle 4: MainActor Isolation
Formatting
Inspiration
This structure is inspired by the Medium article's "Flowの5つのコア原則" section, which clearly communicates Flow's design philosophy. The English documentation now has the same clarity and persuasiveness.
Test Plan
🤖 Generated with Claude Code