Skip to content

docs: consolidate duplicate documentation and relocate root-level files#544

Merged
kcenon merged 1 commit into
mainfrom
docs/issue-543-consolidate-documentation
Jan 24, 2026
Merged

docs: consolidate duplicate documentation and relocate root-level files#544
kcenon merged 1 commit into
mainfrom
docs/issue-543-consolidate-documentation

Conversation

@kcenon

@kcenon kcenon commented Jan 23, 2026

Copy link
Copy Markdown
Owner

Summary

  • Consolidate duplicate documentation files
  • Relocate root-level documentation files to appropriate docs/ subdirectories
  • Improve repository organization following ecosystem documentation standards

What Changed

Files Removed from Root

File Action Target
CHANGELOG.md Merged into docs/CHANGELOG.md -
CHANGELOG_KO.md Merged into docs/CHANGELOG.kr.md -
STRUCTURE.md Deleted (covered by docs/PROJECT_STRUCTURE.md) -

Files Relocated

Source Destination
BASELINE.md docs/performance/BASELINE.md
BASELINE_KO.md docs/performance/BASELINE.kr.md
MIGRATION.md docs/advanced/MIGRATION.md
UDP_SUPPORT.md docs/guides/UDP_SUPPORT.md

Updated Cross-References

  • README.kr.md - Updated BASELINE.md links
  • docs/CHANGELOG.md - Updated MIGRATION.md links
  • docs/CHANGELOG.kr.md - Updated MIGRATION.md links
  • docs/ARCHITECTURE.md - Updated BASELINE.md links
  • docs/BENCHMARKS.md - Updated BASELINE.md links
  • docs/README.md - Added new documentation sections
  • docs/guides/BUILD.md - Updated CHANGELOG.md links
  • docs/guides/BUILD.kr.md - Updated CHANGELOG.md links
  • docs/guides/LOAD_TEST_GUIDE.md - Updated BASELINE.md links
  • integration_tests/README.md - Updated BASELINE.md links
  • integration_tests/README_KO.md - Updated BASELINE.md links

Final Repository Structure

After this change, only README.md and README.kr.md remain at root level.
All other documentation is organized in docs/ subdirectories:

  • docs/performance/ - Performance metrics and baselines
  • docs/advanced/ - Migration guides and advanced topics
  • docs/guides/ - User guides and protocol documentation

Test Plan

  • Verify all internal documentation links resolve correctly
  • Verify no duplicate files remain
  • Verify CHANGELOG is complete after merge

Closes #543

- Remove duplicate CHANGELOG.md from root (merged into docs/CHANGELOG.md)
- Delete STRUCTURE.md (content covered by docs/PROJECT_STRUCTURE.md)
- Move BASELINE.md to docs/performance/BASELINE.md
- Move MIGRATION.md to docs/advanced/MIGRATION.md
- Move UDP_SUPPORT.md to docs/guides/UDP_SUPPORT.md
- Update all internal cross-references to reflect new file locations
- Add new documentation sections to docs/README.md

This improves repository organization by keeping only README.md and
README.kr.md at root level, following ecosystem documentation standards.

Closes #543
@github-actions

Copy link
Copy Markdown
Contributor

Performance Comparison

Base Branch Results

No base results

PR Branch Results

No PR results

@kcenon kcenon merged commit a3c2def into main Jan 24, 2026
41 checks passed
@kcenon kcenon deleted the docs/issue-543-consolidate-documentation branch January 24, 2026 00:29
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.

docs: Consolidate duplicate documentation and relocate root-level files

1 participant