Skip to content

chore(docs): add VERSIONING.md, expand Korean README, remove stray root notes#699

Merged
kcenon merged 2 commits into
developfrom
chore/issue-698-versioning-and-docs
May 30, 2026
Merged

chore(docs): add VERSIONING.md, expand Korean README, remove stray root notes#699
kcenon merged 2 commits into
developfrom
chore/issue-698-versioning-and-docs

Conversation

@kcenon
Copy link
Copy Markdown
Owner

@kcenon kcenon commented May 30, 2026

Closes #698

Summary

  • Add root VERSIONING.md documenting the SemVer policy, the version SSOT (CMake project(... VERSION ...) / CHANGELOG.md), and the release process.
  • Rewrite README.kr.md to mirror the full English README.md heading structure (54/54 headings, identical order and levels) via faithful Korean translation; coverage is ~80% by bytes and ~98% by non-blank content lines, well above the 70% target. Code blocks, badges, links, and identifiers kept verbatim.
  • Remove stray root files ANALYSIS_README.md and README_KO_UPDATE_NOTES.md; record all changes in CHANGELOG.md under [Unreleased].

Test Plan

  • Docs-only change; no build required.
  • Heading structure/order/levels verified to match README.md exactly.
  • No dangling references to the removed files remain.

Follow-ups (tracked under #698)

  • docs/ vs docs/advanced SSOT dedup (ARCHITECTURE/API_REFERENCE/CHANGELOG/PERFORMANCE).
  • Confirm sunset schedule for deprecated forward shims.

kcenon added 2 commits May 30, 2026 22:45
Rewrite README.kr.md to mirror the full English README.md heading
structure (same heading order and levels) via faithful Korean
translation, raising coverage well above the 70% target. Remove the
stray root files ANALYSIS_README.md and README_KO_UPDATE_NOTES.md, and
record all changes in CHANGELOG.md under [Unreleased].
@kcenon kcenon merged commit 3fab0b7 into develop May 30, 2026
1 check passed
@kcenon kcenon deleted the chore/issue-698-versioning-and-docs branch May 30, 2026 21:05
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