Skip to content

docs: sync README and CHANGELOG through v2.8.1#21

Merged
gdtknight merged 1 commit into
developfrom
docs/sync-readme-changelog
Apr 17, 2026
Merged

docs: sync README and CHANGELOG through v2.8.1#21
gdtknight merged 1 commit into
developfrom
docs/sync-readme-changelog

Conversation

@gdtknight
Copy link
Copy Markdown
Owner

Description

README와 docs/CHANGELOG.md가 각각 v2.6.0, v2.4.0 시점에 멈춰 있어 v2.8.1까지의 릴리즈 이력이 문서에 반영되지 않은 상태였습니다. 패키지 재구조화 이후 실제 디렉토리 레이아웃도 README의 구조도와 어긋나 있었기 때문에 함께 정리합니다.

Related Issue

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Code refactoring
  • Performance improvement
  • Build/CI improvement

Changes

  • README 프로젝트 구조 재작성 — v2.8.0에서 도입된 7-패키지 feature 기반 레이아웃(common / scene / spatial / render / lighting / interact / metrics)을 반영. 과거의 평면 구조(parser/, math/, bvh_vis/, display/, utils/ 등) 트리를 제거.
  • README 릴리즈 히스토리 확장 — 누락되어 있던 7개 버전(v2.4.1, v2.5.1, v2.6.1, v2.6.2, v2.7.0, v2.8.0, v2.8.1) 추가.
  • CHANGELOG v2.4.1~v2.8.1 엔트리 추가 — Keep-a-Changelog 형식으로 각 릴리즈의 Added/Changed/Refactored/Renamed/Removed/Fixed 섹션 작성. v2.8.0의 패키지 재구조화, v2.7.0의 대량 심볼 리네이밍, v2.6.2의 카메라 상대 up 수정, v2.8.1의 유지보수 정리(PR chore: remove dead scripts, tests, and stale gitignore entries #19, release: cleanup dead scripts and tests #20) 등을 포괄.

Testing

Test Environment

  • OS: Ubuntu (Linux 6.8.0-106-generic)
  • Compiler: cc (변경 없음 — 문서만 수정)

Test Steps

  1. git diff --stat으로 README/CHANGELOG 외 다른 파일이 건드려지지 않았음을 확인 (2 files changed, 142 insertions, 22 deletions)
  2. 실제 src/ 디렉토리 구조와 README의 트리 일치 여부 수동 검증 (ls src/common src/scene src/spatial src/render src/lighting src/interact src/metrics)
  3. git tag --sort=-v:refname의 태그 목록과 README/CHANGELOG 엔트리 교차 확인 — v2.4.1부터 v2.8.1까지 9개 버전이 모두 포함됨

Test Results

  • All existing tests pass
  • New tests added and passing
  • Manual testing completed
  • Norminette check passed
  • No memory leaks (valgrind/leaks)

Screenshots

Checklist

  • Code follows project style guidelines (norminette)
  • Self-review of code completed
  • Comments added for complex logic
  • Documentation updated (if needed)
  • No new warnings generated
  • Tests added for new functionality
  • All tests passing locally
  • Branch is up to date with base branch
  • Commit messages follow conventional format
  • No sensitive data included

Constitution Compliance

  • 42 Norminette compliance verified
  • Code readability prioritized
  • Unit tests created and passing
  • Documentation updated (English + Korean if applicable)
  • Build verification completed
  • Git branch strategy followed
  • Logs stored in logs/ directory

Performance Impact

  • No performance impact
  • Performance improved
  • Performance decreased (justified below)

Additional Notes

  • 소스 코드, 빌드 설정, 테스트 모두 변경 없음. 순수 문서 업데이트이므로 런타임·CI 영향 없음.
  • wiki 페이지도 비슷하게 낡았을 가능성이 있는데, 이번 PR에서는 범위를 README/CHANGELOG로 한정했습니다. 필요하면 별도 PR로 처리하겠습니다.

🤖 Generated with Claude Code

README was stuck at v2.6.0 and docs/CHANGELOG.md at v2.4.0, both
missing the accumulated release history from the package
restructuring work.

- README: rewrite the project structure tree to reflect the
  7-package feature-based layout introduced in v2.8.0 (common,
  scene, spatial, render, lighting, interact, metrics), replacing
  the stale flat layout. Extend the release history table with
  entries for v2.4.1, v2.5.0, v2.5.1, v2.6.0, v2.6.1, v2.6.2,
  v2.7.0, v2.8.0, and v2.8.1.
- CHANGELOG: add full Keep-a-Changelog entries for v2.4.1
  through v2.8.1, including the module restructurings, header
  cleanups, camera pitch fix, and the v2.8.1 maintenance
  cleanup (PRs #19, #20).

Pure documentation update — no source or build changes.

Co-Authored-By: Claude <noreply@anthropic.com>
@gdtknight gdtknight self-assigned this Apr 17, 2026
@gdtknight gdtknight added the documentation Improvements or additions to documentation label Apr 17, 2026
@gdtknight gdtknight merged commit 42b0b3a into develop Apr 17, 2026
16 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in @gdtknight's miniRT Apr 17, 2026
@gdtknight gdtknight deleted the docs/sync-readme-changelog branch April 17, 2026 00:37
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

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant