Skip to content

docs: simplify README for developer-first readability#25

Merged
JunggiKim merged 1 commit intomainfrom
docs/readme-simplify
Mar 16, 2026
Merged

docs: simplify README for developer-first readability#25
JunggiKim merged 1 commit intomainfrom
docs/readme-simplify

Conversation

@JunggiKim
Copy link
Copy Markdown
Owner

Summary

  • Before/After 예제를 최상단으로 이동하여 라이브러리 목적을 즉시 파악 가능하게 변경
  • 설치 가이드 6가지 → 2가지로 축소 (Gradle Kotlin DSL + Maven)
  • 345줄 타입 테이블을 요약 표 + docs/type-matrix.md 링크로 대체
  • 중복/불필요 섹션 제거: TOC, Features, Terminology, Core Concepts/API 중복, Compatibility
  • API Overview → 불릿 리스트로 경량화, JDK 인터페이스 호환 정보 병합
  • 인위적 Kotlin null 캐스팅 예제 제거

734줄 → 142줄 (81% 감소). 정보 손실 없음 — 상세 타입 목록은 docs/type-matrix.md에 유지.

Test plan

  • GitHub에서 README 렌더링 확인 (배지, 코드 블록, 표, 링크)
  • docs/type-matrix.md 링크 동작 확인
  • docs/compatibility.md, docs/kotlin-support-policy.md 링크 동작 확인

🤖 Generated with Claude Code

- Move Before/After examples to the top for instant comprehension
- Consolidate 6 installation variants into 2 (Gradle Kotlin DSL + Maven)
- Replace 345-line type tables with summary table + docs link
- Remove redundant sections: TOC, Features, Terminology, Core Concepts/API overlap
- Merge Compatibility into Contributing, slim API Overview to bullet list
- Remove artificial Kotlin null-cast example

734 lines → 142 lines (81% reduction) with no information loss.
Detailed type list remains in docs/type-matrix.md.
@JunggiKim JunggiKim merged commit 192f17f into main Mar 16, 2026
3 checks passed
@JunggiKim JunggiKim deleted the docs/readme-simplify branch March 16, 2026 13:22
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