Skip to content

docs: Relocate root-level documentation files and consolidate duplicates #519

Description

@kcenon

Summary

Relocate documentation files from root level to appropriate docs/ subdirectories and consolidate duplicate documents to improve repository organization and reduce maintenance burden.

Background (Why)

  • Multiple documentation files exist at root level that should be in docs/
  • THREAD_SYSTEM_CAPABILITIES_SUMMARY.md (762 lines) significantly overlaps with docs/FEATURES.md (959 lines)
  • EXPLORATION_SUMMARY.md appears to be a temporary analysis document
  • ARCHITECTURE_DIAGRAM.md at root level breaks documentation organization pattern
  • Numbered files in docs/advanced/ (01-ARCHITECTURE.md, 02-API_REFERENCE.md) are redundant with main docs
  • Current structure doesn't follow ecosystem documentation standards

Root-level files that need attention:

thread_system/
├── README.md                              # OK - stays at root
├── README.kr.md                           # OK - stays at root
├── THREAD_SYSTEM_CAPABILITIES_SUMMARY.md  # Should merge into docs/FEATURES.md
├── EXPLORATION_SUMMARY.md                 # Should be deleted (temp file)
└── ARCHITECTURE_DIAGRAM.md                # Should move to docs/

Scope (What)

Current State

File Lines Location Issue
THREAD_SYSTEM_CAPABILITIES_SUMMARY.md 762 root ~90% duplicate with FEATURES.md
EXPLORATION_SUMMARY.md varies root Temporary analysis document
ARCHITECTURE_DIAGRAM.md varies root Should be in docs/
docs/advanced/01-ARCHITECTURE.md varies docs/advanced/ Redundant numbering
docs/advanced/02-API_REFERENCE.md varies docs/advanced/ Redundant numbering

Proposed State

thread_system/
├── README.md
├── README.kr.md
└── docs/
    ├── FEATURES.md                    # Enhanced with unique content from CAPABILITIES_SUMMARY
    ├── ARCHITECTURE_DIAGRAM.md        # Moved from root
    └── advanced/
        ├── ARCHITECTURE.md            # Renamed from 01-ARCHITECTURE.md
        └── API_REFERENCE.md           # Renamed from 02-API_REFERENCE.md

Impact Analysis (Where)

Files to Modify

Action File Reason
Delete THREAD_SYSTEM_CAPABILITIES_SUMMARY.md Content merged into FEATURES.md
Delete EXPLORATION_SUMMARY.md Temporary document, no longer needed
Move ARCHITECTURE_DIAGRAM.mddocs/ Follow standard structure
Rename docs/advanced/01-ARCHITECTURE.mdARCHITECTURE.md Remove unnecessary numbering
Rename docs/advanced/02-API_REFERENCE.mdAPI_REFERENCE.md Remove unnecessary numbering
Update docs/FEATURES.md Add unique content from CAPABILITIES_SUMMARY
Update docs/README.md Update navigation links

Cross-Reference Updates

  • Any links to deleted/moved files in README.md
  • Any links in docs/README.md navigation
  • Any external documentation references

Implementation Plan (How)

Phase 1: Content Analysis

  1. Compare THREAD_SYSTEM_CAPABILITIES_SUMMARY.md with docs/FEATURES.md
  2. Identify unique content in CAPABILITIES_SUMMARY not in FEATURES.md
  3. Document content to be merged

Phase 2: Content Merge

  1. Add unique content from CAPABILITIES_SUMMARY to FEATURES.md
  2. Verify FEATURES.md is comprehensive and well-organized
  3. Review merged document for consistency

Phase 3: File Operations

  1. Delete THREAD_SYSTEM_CAPABILITIES_SUMMARY.md
  2. Delete EXPLORATION_SUMMARY.md
  3. Move ARCHITECTURE_DIAGRAM.md to docs/
  4. Rename docs/advanced/01-ARCHITECTURE.md to ARCHITECTURE.md
  5. Rename docs/advanced/02-API_REFERENCE.md to API_REFERENCE.md

Phase 4: Link Updates

  1. Update README.md to remove/update references
  2. Update docs/README.md navigation
  3. Search and update any other internal links

Phase 5: Verification

  1. Verify all links work correctly
  2. Verify no broken references in documentation
  3. Run any documentation build/validation scripts

Acceptance Criteria

  • No documentation files at root level (except README.md, README.kr.md)
  • docs/FEATURES.md contains all relevant feature documentation
  • docs/advanced/ files have clean names without numbering prefixes
  • All internal documentation links are valid
  • Documentation structure matches ecosystem standard
  • No content loss from consolidation

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