docs: Improve README based on CoreConcepts documentation#4
Merged
takeshishimada merged 1 commit intomainfrom Oct 27, 2025
Merged
docs: Improve README based on CoreConcepts documentation#4takeshishimada merged 1 commit intomainfrom
takeshishimada merged 1 commit intomainfrom
Conversation
Enhance the "Result-Returning Actions" section in both English
and Japanese READMEs to provide clearer explanations:
**Changes:**
- Add explicit mention that ActionResult type can be freely defined
- Provide context for the example ("child view returns selection result")
- Restructure benefits as "This implementation provides:" with detailed points
- Clarify how ChildFeature, ParentView, and callbacks work together
- Emphasize dependency tracking within the view tree
**Impact:**
- Better understanding of the result-returning pattern
- Clearer explanation of parent-child communication
- More explicit benefits and use cases
These improvements align the README with the detailed explanations
found in CoreConcepts.md documentation.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
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
Enhance the "Result-Returning Actions" section in both English and Japanese READMEs to provide clearer and more detailed explanations, aligning with the comprehensive documentation in CoreConcepts.md.
Changes
README.md (English)
Before:
After:
README_jp.md (Japanese)
Similar improvements applied to the Japanese version with culturally appropriate phrasing.
Improvements
ActionResultcan be freely defined per FeatureImpact
Files Changed
README.md(+8 lines, -3 lines)README_jp.md(+8 lines, -3 lines)🤖 Generated with Claude Code