Skip to content

docs: Reduce redundant expressions in English documentation#2

Merged
takeshishimada merged 1 commit intomainfrom
docs/reduce-redundant-expressions
Oct 26, 2025
Merged

docs: Reduce redundant expressions in English documentation#2
takeshishimada merged 1 commit intomainfrom
docs/reduce-redundant-expressions

Conversation

@takeshishimada
Copy link
Copy Markdown
Contributor

Summary

This PR improves documentation clarity by reducing redundant expressions and updating version numbers to 1.0.0.

Changes

GettingStarted.md

  • ✅ Update version from 0.1.6 to 1.0.0 (2 locations)

README.md

  • ✅ Simplify opening description: "A type-safe state management library for SwiftUI applications"
  • ✅ Change "Reduced code" to "Less boilerplate code" for clarity
  • ✅ Remove duplicate bullet point "Caught at compile time, not runtime" (already mentioned in line 185)
  • ✅ Consolidate middleware description from 2 sentences to 1
  • ✅ Simplify "Use for..." to "...support" for more direct phrasing

Impact

  • Readability: Improved conciseness without losing technical accuracy
  • Consistency: Version numbers now match CHANGELOG.md (1.0.0 release)
  • Clarity: More specific language ("Less boilerplate code" vs "Reduced code")
  • Duplication: Removed redundant information

Files Changed

  • README.md (5 improvements)
  • Sources/Flow/Flow.docc/GettingStarted.md (2 version updates)

Review Notes

All changes were carefully reviewed to ensure:

  • Technical accuracy is maintained
  • Meaning and intent are preserved
  • Community-friendly tone is retained
  • No important emphasis is lost

🤖 Generated with Claude Code

- Update version from 0.1.6 to 1.0.0 in GettingStarted.md
- Simplify opening description for better readability
- Change "Reduced code" to "Less boilerplate code" for clarity
- Remove duplicate "Caught at compile time" bullet point
- Consolidate middleware description into single sentence
- Simplify "Use for" to more direct phrasing

These changes improve documentation clarity without changing
technical accuracy or meaning.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 26, 2025
@takeshishimada takeshishimada self-assigned this Oct 26, 2025
@takeshishimada takeshishimada merged commit 7ce5eca into main Oct 26, 2025
9 checks passed
@takeshishimada takeshishimada deleted the docs/reduce-redundant-expressions branch October 26, 2025 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant