Skip to content

docs: Consolidate duplicate documentation and relocate root-level files #543

Description

@kcenon

Summary

Consolidate duplicate documentation files (especially CHANGELOG.md) and relocate multiple root-level documentation files to appropriate docs/ subdirectories to improve repository organization and eliminate maintenance duplication.

Background (Why)

  • CHANGELOG.md exists at both root (1044 lines) and docs/ (595 lines) - content divergence risk
  • Multiple documentation files at root level break standard repository structure
  • BASELINE.md, STRUCTURE.md, MIGRATION.md, UDP_SUPPORT.md all at root level
  • Maintaining duplicate files increases risk of inconsistent information
  • Current structure doesn't follow ecosystem documentation standards

Current root-level documentation clutter:

network_system/
├── README.md                 # OK - stays at root
├── README.kr.md              # OK - stays at root
├── CHANGELOG.md              # DUPLICATE - also in docs/
├── BASELINE.md               # Should be in docs/performance/
├── STRUCTURE.md              # Should be merged with docs/PROJECT_STRUCTURE.md
├── MIGRATION.md              # Should be in docs/advanced/
└── UDP_SUPPORT.md            # Should be in docs/guides/

Scope (What)

Current State (Duplicates and Misplaced Files)

File Location Lines Issue
CHANGELOG.md root 1044 Duplicate with docs/CHANGELOG.md (595 lines)
CHANGELOG.md docs/ 595 Original location - keep this
BASELINE.md root varies Should be in docs/performance/
STRUCTURE.md root varies Overlaps with docs/PROJECT_STRUCTURE.md
MIGRATION.md root varies Should be in docs/advanced/
UDP_SUPPORT.md root varies Should be in docs/guides/

Proposed State

network_system/
├── README.md
├── README.kr.md
└── docs/
    ├── CHANGELOG.md           # Consolidated (merged from root)
    ├── PROJECT_STRUCTURE.md   # Enhanced with root STRUCTURE.md content
    ├── advanced/
    │   └── MIGRATION.md       # Moved from root
    ├── guides/
    │   └── UDP_SUPPORT.md     # Moved from root
    └── performance/
        └── BASELINE.md        # Moved from root

Impact Analysis (Where)

Files to Modify

Action Source Target Reason
Delete root CHANGELOG.md - Duplicate, keep docs/ version
Merge root CHANGELOG.md unique entries docs/CHANGELOG.md Consolidate history
Move root BASELINE.md docs/performance/BASELINE.md Standard location
Merge root STRUCTURE.md docs/PROJECT_STRUCTURE.md Consolidate structure docs
Move root MIGRATION.md docs/advanced/MIGRATION.md Standard location
Move root UDP_SUPPORT.md docs/guides/UDP_SUPPORT.md Standard location

CHANGELOG Comparison

Aspect Root CHANGELOG docs/CHANGELOG
Lines 1044 595
Latest Entry Unreleased 2025-09-20 - Phase 4
Format Keep a Changelog Keep a Changelog
Action Merge unique entries, delete Keep as primary

Implementation Plan (How)

Phase 1: CHANGELOG Consolidation

  1. Compare root CHANGELOG.md with docs/CHANGELOG.md
  2. Identify entries in root that are missing from docs/
  3. Merge unique entries into docs/CHANGELOG.md
  4. Delete root CHANGELOG.md

Phase 2: STRUCTURE.md Consolidation

  1. Compare root STRUCTURE.md with docs/PROJECT_STRUCTURE.md
  2. Merge unique content into docs/PROJECT_STRUCTURE.md
  3. Delete root STRUCTURE.md

Phase 3: File Relocations

  1. Move BASELINE.md to docs/performance/BASELINE.md
  2. Move MIGRATION.md to docs/advanced/MIGRATION.md
  3. Move UDP_SUPPORT.md to docs/guides/UDP_SUPPORT.md

Phase 4: Link Updates

  1. Update README.md to reflect new file locations
  2. Update docs/README.md navigation
  3. Search and update any internal cross-references
  4. Update any external documentation links

Phase 5: Verification

  1. Verify all documentation links work
  2. Verify no duplicate files remain
  3. Verify CHANGELOG is complete after merge

Acceptance Criteria

  • Only README.md and README.kr.md at root level
  • Single CHANGELOG.md in docs/ with all history
  • BASELINE.md in docs/performance/
  • MIGRATION.md in docs/advanced/
  • UDP_SUPPORT.md in docs/guides/
  • All internal documentation links are valid
  • No content loss from consolidation
  • Documentation structure matches ecosystem standard

Related Issues

Labels

  • documentation
  • enhancement
  • cleanup

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions