Skip to content

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

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

docs: Relocate root-level documentation files and consolidate duplicates#521
kcenon merged 1 commit into
mainfrom
docs/issue-519-relocate-documentation

Conversation

@kcenon

@kcenon kcenon commented Jan 24, 2026

Copy link
Copy Markdown
Owner

Summary

Relocates documentation files from root level to appropriate docs/ subdirectories and removes duplicate/temporary documents to improve repository organization.

Changes Made

Files Deleted

  • EXPLORATION_SUMMARY.md - Temporary analysis document, no longer needed
  • THREAD_SYSTEM_CAPABILITIES_SUMMARY.md - Content consolidated into docs/FEATURES.md

Files Moved

  • ARCHITECTURE_DIAGRAM.mddocs/ARCHITECTURE_DIAGRAM.md

Files Renamed

  • docs/advanced/01-ARCHITECTURE.mddocs/advanced/ARCHITECTURE.md
  • docs/advanced/02-API_REFERENCE.mddocs/advanced/API_REFERENCE.md
  • docs/advanced/01-ARCHITECTURE.kr.mddocs/advanced/ARCHITECTURE.kr.md
  • docs/advanced/02-API_REFERENCE.kr.mddocs/advanced/API_REFERENCE.kr.md

Cross-Reference Updates

  • Updated README.md to reference new file locations
  • Removed all references to deleted files

Benefits

  • Clean root directory (only README.md and README.kr.md remain)
  • Consistent documentation structure following ecosystem standards
  • Removed redundant numbering prefixes from advanced documentation
  • No content loss - all relevant information preserved in docs/FEATURES.md

Verification

  • All documentation links in README.md verified
  • No broken references to deleted files
  • All moved files accessible at new locations
  • Korean documentation files updated correspondingly

Related Issues

Closes #519

Test Plan

  1. Verify no documentation files exist at root level (except README files)
  2. Check that docs/FEATURES.md contains comprehensive feature documentation
  3. Verify all links in README.md point to correct locations
  4. Confirm advanced documentation has clean names without number prefixes

Remove temporary and redundant files:
- Delete EXPLORATION_SUMMARY.md (temporary analysis document)
- Delete THREAD_SYSTEM_CAPABILITIES_SUMMARY.md (content merged into docs/FEATURES.md)

Reorganize documentation structure:
- Move ARCHITECTURE_DIAGRAM.md to docs/ directory
- Rename docs/advanced/01-ARCHITECTURE.md to ARCHITECTURE.md
- Rename docs/advanced/02-API_REFERENCE.md to API_REFERENCE.md
- Update Korean variants (ARCHITECTURE.kr.md, API_REFERENCE.kr.md)

Update cross-references:
- Update README.md links to reflect new file locations
- Remove numbered prefixes from advanced documentation

This consolidation improves documentation organization and follows
ecosystem documentation standards by keeping all docs in docs/
directory and removing redundant numbering schemes.

Closes #519
@github-actions

Copy link
Copy Markdown
Contributor

📊 Performance Benchmark Results

Performance Benchmark Report

No benchmark data available.

ℹ️ No baseline reference available

This is the first benchmark run or baseline file is missing.

@kcenon kcenon merged commit 729cc78 into main Jan 24, 2026
26 checks passed
@kcenon kcenon deleted the docs/issue-519-relocate-documentation branch January 24, 2026 04:09
kcenon added a commit that referenced this pull request Apr 13, 2026
…#521)

Remove temporary and redundant files:
- Delete EXPLORATION_SUMMARY.md (temporary analysis document)
- Delete THREAD_SYSTEM_CAPABILITIES_SUMMARY.md (content merged into docs/FEATURES.md)

Reorganize documentation structure:
- Move ARCHITECTURE_DIAGRAM.md to docs/ directory
- Rename docs/advanced/01-ARCHITECTURE.md to ARCHITECTURE.md
- Rename docs/advanced/02-API_REFERENCE.md to API_REFERENCE.md
- Update Korean variants (ARCHITECTURE.kr.md, API_REFERENCE.kr.md)

Update cross-references:
- Update README.md links to reflect new file locations
- Remove numbered prefixes from advanced documentation

This consolidation improves documentation organization and follows
ecosystem documentation standards by keeping all docs in docs/
directory and removing redundant numbering schemes.

Closes #519
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: Relocate root-level documentation files and consolidate duplicates

1 participant