Skip to content

docs: simplify README — remove advanced patterns, fix Kotlin examples#28

Merged
JunggiKim merged 1 commit intomainfrom
docs/readme-cleanup
Mar 17, 2026
Merged

docs: simplify README — remove advanced patterns, fix Kotlin examples#28
JunggiKim merged 1 commit intomainfrom
docs/readme-cleanup

Conversation

@JunggiKim
Copy link
Copy Markdown
Owner

Summary

  • Remove Usage Patterns section (mapError, recover, Validated zip) — advanced patterns for docs/
  • Remove Violation internal structure description from API section
  • Fix Kotlin Support: split duplicate val age into separate code blocks
  • Move Installation before Quick Start for natural flow
  • Add Docs section with links to existing documentation
  • Deduplicate ofOrElse between Quick Start and Usage Patterns

Cross-reviewed by Codex CLI and Gemini CLI. Both agreed on all changes.

Validation

  • ./gradlew clean check testJava8 jacocoTestReport pitest javadoc

Checklist

  • public API or behavior changes are documented
  • coverage gate still passes
  • Java 8 compatibility preserved

🤖 Generated with Claude Code

- Remove Usage Patterns section (mapError, recover, Validated zip) — advanced patterns belong in docs/
- Remove Violation internal structure description from API section
- Fix Kotlin Support: split duplicate val age into separate code blocks
- Move Installation before Quick Start for natural flow
- Add Docs section with links to type-matrix, compatibility, kotlin-support-policy
- Deduplicate ofOrElse between Quick Start and Usage Patterns
@JunggiKim JunggiKim merged commit 5626979 into main Mar 17, 2026
3 checks passed
@JunggiKim JunggiKim deleted the docs/readme-cleanup branch March 17, 2026 07:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant